1"use strict";(self.webpackChunklitmus_docs2_0=self.webpackChunklitmus_docs2_0||[]).push([[3563],{603905:function(e,t,n){n.d(t,{Zo:function(){return u},kt:function(){return h}});var a=n(667294);function r(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 a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}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){r(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 o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),p=c(n),d=r,h=p["".concat(s,".").concat(d)]||p[d]||m[d]||l;return n?a.createElement(h,i(i({ref:t},u),{},{components:n})):a.createElement(h,i({ref:t},u))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[p]="string"==typeof e?e:r,i[1]=o;for(var c=2;c<l;c++)i[c]=n[c];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"},597216:function(e,t,n){n.r(t),n.d(t,{contentTitle:function(){return s},default:function(){return d},frontMatter:function(){return o},metadata:function(){return c},toc:function(){return u}});var a=n(487462),r=n(263366),l=(n(667294),n(603905)),i=["components"],o={id:"additional-commands",title:"Additional Commands",sidebar_label:"Additional Commands"},s=void 0,c={unversionedId:"litmusctl/additional-commands",id:"litmusctl/additional-commands",title:"Additional Commands",description:"-------------------------------",source:"@site/docs/litmusctl/additional-commands.md",sourceDirName:"litmusctl",slug:"/litmusctl/additional-commands",permalink:"/docs/next/litmusctl/additional-commands",editUrl:"https://github.com/litmuschaos/litmus-docs/edit/master/website/docs/litmusctl/additional-commands.md",tags:[],version:"current",frontMatter:{id:"additional-commands",title:"Additional Commands",sidebar_label:"Additional Commands"},sidebar:"docs",previous:{title:"Create Chaos Experiment",permalink:"/docs/next/litmusctl/create-chaos-experiment"},next:{title:"Prometheus",permalink:"/docs/next/integrations/prometheus"}},u=[{value:"Account and Configuration Commands",id:"account-and-configuration-commands",children:[{value:"View Current Configuration",id:"view-current-configuration",children:[],level:3},{value:"List Accounts",id:"list-accounts",children:[],level:3},{value:"Switch Account",id:"switch-account",children:[],level:3},{value:"Update Password",id:"update-password",children:[],level:3}],level:2},{value:"Project and Environment Management",id:"project-and-environment-management",children:[{value:"Create a Project",id:"create-a-project",children:[],level:3},{value:"Create an Environment",id:"create-an-environment",children:[],level:3},{value:"Delete an Environment",id:"delete-an-environment",children:[],level:3},{value:"List Projects",id:"list-projects",children:[],level:3},{value:"List Environments",id:"list-environments",children:[],level:3}],level:2}
1,{value:"Chaos Infrastructure Management",id:"chaos-infrastructure-management",children:[{value:"Get Chaos Infrastructures",id:"get-chaos-infrastructures",children:[],level:3},{value:"Disconnect Chaos Infrastructure",id:"disconnect-chaos-infrastructure",children:[],level:3}],level:2},{value:"Chaos Experiment Management",id:"chaos-experiment-management",children:[{value:"List Experiments",id:"list-experiments",children:[],level:3},{value:"Describe a Chaos Experiment",id:"describe-a-chaos-experiment",children:[],level:3},{value:"Delete a Chaos Experiment",id:"delete-a-chaos-experiment",children:[],level:3},{value:"List Experiment Runs",id:"list-experiment-runs",children:[],level:3},{value:"Get Experiment Run by ID",id:"get-experiment-run-by-id",children:[],level:3}],level:2},{value:"Flag Reference",id:"flag-reference",children:[],level:2}],p={toc:u},m="wrapper";function d(e){var t=e.components,n=(0,r.Z)(e,i);return(0,l.kt)(m,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("hr",null),(0,l.kt)("p",null,"This guide covers additional litmusctl commands for managing your ChaosCenter account, projects, environments, and chaos infrastructures."),(0,l.kt)("p",null,"Follow this ",(0,l.kt)("a",{parentName:"p",href:"https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands"},"guide")," to learn more about litmusctl commands."),(0,l.kt)("hr",null),(0,l.kt)("h2",{id:"account-and-configuration-commands"},"Account and Configuration Commands"),(0,l.kt)("h3",{id:"view-current-configuration"},"View Current Configuration"),(0,l.kt)("p",null,"Displays the current configuration from ",(0,l.kt)("inlineCode",{parentName:"p"},".litmusconfig"),"."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl config view\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example Output:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},'accounts:\n- users:\n - username: admin\n expires_in: "1626897027"\n token: eyJhbGciOi...\n endpoint: https://preview.litmuschaos.io\napiVersion: v1\ncurrent-account: https://preview.litmuschaos.io\ncurrent-user: admin\nkind: Config\n')),(0,l.kt)("h3",{id:"list-accounts"},"List Accounts"),(0,l.kt)("p",null,"Shows all accounts configured in ",(0,l.kt)("inlineCode",{parentName:"p"},".litmusconfig"),"."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl config get-accounts\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example Output:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"CURRENT ENDPOINT USERNAME EXPIRESIN\n https://preview.litmuschaos.io admin 2021-07-22 01:20:27 +0530 IST\n* https://preview.litmuschaos.io raj 2021-07-22 14:33:22 +0530 IST\n")),(0,l.kt)("h3",{id:"switch-account"},"Switch Account"),(0,l.kt)("p",null,"Switch between multiple configured accounts."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl config use-account\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Host endpoint where litmus is installed: https://preview.litmuschaos.io\nUsername: admin\nSuccessfully set the current account to 'admin' at 'https://preview.litmuschaos.io'\n")),(0,l.kt)("h3",{id:"update-password"},"Update Password"),(0,l.kt)("p",null,"Change your ChaosCenter account password."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl update password\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Username: admin\nOld Password: ********\nNew Password: ********\nConfirm Password: ********\nPassword updated successfully!\n")),(0,l.kt)("hr",null),(0,l.kt)("h2",{id:"project-and-environment-management"},"Project and Environment Management"),(0,l.kt)("h3",{id:"create-a-project"},"Create a Project"),(0,l.kt)("p",null,"Creates a new project in ChaosCenter."),(0,l.kt)("pre",null,(0,l.kt)("c
1ode",{parentName:"pre",className:"language-bash"},"litmusctl create project\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Enter a project name: new\nProject 'new' created successfully!\n")),(0,l.kt)("h3",{id:"create-an-environment"},"Create an Environment"),(0,l.kt)("p",null,"Creates a new environment within a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl create environment\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Enter the Project ID: eb7fc0a0-5878-4454-a9db-b67d283713bc\nEnter the Environment Name: test2\nNew Chaos Environment creation successful!\n")),(0,l.kt)("h3",{id:"delete-an-environment"},"Delete an Environment"),(0,l.kt)("p",null,"Deletes an existing environment from a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl delete chaos-environment\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Enter the Project ID: eb7fc0a0-5878-4454-a9db-b67d283713bc\nEnter the Environment ID: testenv\nAre you sure you want to delete this Chaos Environment? (y/n): y\nChaos Environment deleted successfully.\n")),(0,l.kt)("h3",{id:"list-projects"},"List Projects"),(0,l.kt)("p",null,"View all available projects."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl get projects\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"PROJECT ID PROJECT NAME CREATEDAT\n50addd40-8767-448c-a91a-5071543a2d8e Developer Project 2021-07-21 14:38:51 +0530 IST\n7a4a259a-1ae5-4204-ae83-89a8838eaec3 DevOps Project 2021-07-21 14:39:14 +0530 IST\n")),(0,l.kt)("h3",{id:"list-environments"},"List Environments"),(0,l.kt)("p",null,"List all environments within a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl list chaos-environments --project-id=""\n')),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"CHAOS ENVIRONMENT ID CHAOS ENVIRONMENT NAME CREATED AT CREATED BY\ntestenv testenv 55985-01-15 01:42:33 +0530 IST admin\nshivamnewenv shivamnewenv 55962-10-01 15:05:45 +0530 IST admin\n")),(0,l.kt)("hr",null),(0,l.kt)("h2",{id:"chaos-infrastructure-management"},"Chaos Infrastructure Management"),(0,l.kt)("h3",{id:"get-chaos-infrastructures"},"Get Chaos Infrastructures"),(0,l.kt)("p",null,"List all Chaos Infrastructures in a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"litmusctl get chaos-infra\n")),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"CHAOS INFRASTRUCTURE ID CHAOS INFRASTRUCTURE NAME STATUS\n55ecc7f2-2754-43aa-8e12-6903e4c6183a chaos-infra-1 ACTIVE\n13dsf3d1-5324-54af-4g23-5331g5v2364f chaos-infra-2 INACTIVE\n")),(0,l.kt)("h3",{id:"disconnect-chaos-infrastructure"},"Disconnect Chaos Infrastructure"),(0,l.kt)("p",null,"Disconnect a Chaos Infrastructure from a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl disconnect chaos-infra <chaos-infra-id> --project-id=""\n')),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example Output:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Chaos Infrastructure successfully disconnected.\n")),(0,l.kt)("hr",null),(0,l.kt)("h2",{id:"chaos-experiment-management"},"Chaos Experiment Management"),(0,l.kt)("h3",{id:"list-experiments"},"List Experiments"),(0,l.kt)("p",null,"Get all Chaos Experiments in a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl get chaos-experiment --project-id=""\n')),(0,l.kt)("h3",{id:"describe-a-chaos-experiment"}
1,"Describe a Chaos Experiment"),(0,l.kt)("p",null,"View details of a specific Chaos Experiment."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl describe chaos-experiment <chaos-experiment-id> --project-id=""\n')),(0,l.kt)("h3",{id:"delete-a-chaos-experiment"},"Delete a Chaos Experiment"),(0,l.kt)("p",null,"Remove a specific Chaos Experiment."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl delete chaos-experiment <chaos-experiment-id> --project-id=""\n')),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Example Output:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"Chaos Experiment successfully deleted.\n")),(0,l.kt)("h3",{id:"list-experiment-runs"},"List Experiment Runs"),(0,l.kt)("p",null,"Get all Chaos Experiment runs within a project."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl get chaos-experiment-runs --project-id=""\n')),(0,l.kt)("h3",{id:"get-experiment-run-by-id"},"Get Experiment Run by ID"),(0,l.kt)("p",null,"Get details of a specific Chaos Experiment run."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},'litmusctl get chaos-experiment-runs --project-id="" --experiment-run-id=""\n')),(0,l.kt)("hr",null),(0,l.kt)("h2",{id:"flag-reference"},"Flag Reference"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Flag"),(0,l.kt)("th",{parentName:"tr",align:null},"Short"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"--cacert")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"Custom CA certificate used by litmusctl for portal communication")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"--config")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"Configuration file path (default ",(0,l.kt)("inlineCode",{parentName:"td"},"$HOME/.litmusctl"),")")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"--skipSSL")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"bool"),(0,l.kt)("td",{parentName:"tr",align:null},"Skip SSL/TLS verification")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"--help")),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"-h")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Display help for command")))),(0,l.kt)("hr",null),(0,l.kt)("p",null,"This update aligns the ",(0,l.kt)("inlineCode",{parentName:"p"},"additional-command.md")," documentation with ",(0,l.kt)("inlineCode",{parentName:"p"},"litmusctl v0.23.0+"),", ensuring users have access to the latest command syntax, examples, and flag information."))}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.