CLI command reference¶

Generated from the eve-iac CLI parser (cli/eveiac_cli/main.py). Do not edit manually.

eve-iac is the reference CLI for the public Python SDK. It does not call native EVE REST.

Synopsis¶

eve-iac [GLOBAL OPTIONS] COMMAND [OPTIONS] [ARGS]

Global flags may appear before or after the command because every subparser inherits them.

Global options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD

CLI flags win over environment variables. Omitted flags use argparse.SUPPRESS, so they are not serialized as defaults.

CA resolution: --ca-file / EVE_IAC_CA_FILE is read from disk when set; otherwise --ca-pem / EVE_IAC_CA_PEM. There is no TOFU UI.

Exit codes¶

Code	Meaning
0	Success
1	Local error (missing URL, invalid lab)
2	Usage
3	Authentication
4	TLS
5	Confirmation required (--yes missing)
10	Agent error

--json writes SDK result JSON to stdout on success. Failures with --json write an error object to stdout.

Safety (--yes)¶

--yes is required for destroy, exec wipe, deploy --replace, and reconcile --prune. There are no interactive prompts.

from_eve plus --prune is rejected (usage): prune is a to_eve topology delete.

eve-iac health¶

Synopsis¶

eve-iac health [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                      [--ca-pem CA_PEM] [--json] [--yes]
                      [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                      [--password PASSWORD]

Description¶

GET agent health (no token required)

Arguments¶

None.

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac health
eve-iac --url https://eve.example:8787 --ca-file ./ca.pem health

eve-iac login¶

Synopsis¶

eve-iac login [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                     [--ca-pem CA_PEM] [--json] [--yes]
                     [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                     [--password PASSWORD]

Description¶

Create an agent session

Arguments¶

None.

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac login --username admin --password secret
eve-iac login --json

eve-iac session¶

Synopsis¶

eve-iac session [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                       [--ca-pem CA_PEM] [--json] [--yes]
                       [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                       [--password PASSWORD]

Description¶

Validate the current token

Arguments¶

None.

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac session

eve-iac templates¶

Synopsis¶

eve-iac templates [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                         [--ca-pem CA_PEM] [--json] [--yes]
                         [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                         [--password PASSWORD] [--provisioned]

Description¶

List templates

Arguments¶

None.

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--provisioned	flag	False	Send provisioned=true (omit the query when unset)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac templates
eve-iac templates --provisioned --json

eve-iac validate¶

Synopsis¶

eve-iac validate [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                        [--ca-pem CA_PEM] [--json] [--yes]
                        [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                        [--password PASSWORD] [--lab LAB]
                        project

Description¶

Validate a packed lab

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac validate ./lab
eve-iac validate ./lab --json

eve-iac import¶

Synopsis¶

eve-iac import [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                      [--ca-pem CA_PEM] [--json] [--yes]
                      [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                      [--password PASSWORD] [--lab LAB]
                      project

Description¶

Import into a managed working copy (does not mutate source_lab)

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac import ./imported-lab

eve-iac plan¶

Synopsis¶

eve-iac plan [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                    [--ca-pem CA_PEM] [--json] [--yes]
                    [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                    [--password PASSWORD] [--lab LAB]
                    [--direction {to_eve,from_eve}]
                    [--plan-identity PLAN_IDENTITY]
                    project

Description¶

Dry-run plan

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--direction	to_eve|from_eve	omitted	Omitted stays omitted (agent treats omitted as to_eve)
--plan-identity	PLAN-IDENTITY	omitted	Opaque plan token from the last same-direction plan

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac plan ./lab
eve-iac plan ./lab --json
eve-iac plan ./lab --direction to_eve
eve-iac plan ./lab --direction from_eve

eve-iac reconcile¶

Synopsis¶

eve-iac reconcile [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                         [--ca-pem CA_PEM] [--json] [--yes]
                         [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                         [--password PASSWORD] [--lab LAB]
                         [--direction {to_eve,from_eve}]
                         [--plan-identity PLAN_IDENTITY] [--prune]
                         project

Description¶

Apply a plan

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--direction	to_eve|from_eve	omitted	Omitted stays omitted (agent treats omitted as to_eve)
--plan-identity	PLAN-IDENTITY	omitted	Opaque plan token from the last same-direction plan
--prune	flag	False	Delete extra live objects (requires --yes)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac reconcile ./lab --direction to_eve
eve-iac reconcile ./lab --direction from_eve
eve-iac reconcile ./lab --prune --yes

eve-iac deploy¶

Synopsis¶

eve-iac deploy [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                      [--ca-pem CA_PEM] [--json] [--yes]
                      [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                      [--password PASSWORD] [--lab LAB] [--replace]
                      project

Description¶

Create the managed lab

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--replace	flag	False	Replace an existing managed lab (requires --yes)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac deploy ./lab
eve-iac deploy ./lab --replace --yes

eve-iac destroy¶

Synopsis¶

eve-iac destroy [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                       [--ca-pem CA_PEM] [--json] [--yes]
                       [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                       [--password PASSWORD] [--lab LAB] [--no-wipe]
                       project

Description¶

Destroy the managed lab (requires --yes)

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--no-wipe	flag	omitted	Send wipe=false (omitted wipe still means wipe nodes on the agent)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac destroy ./lab --yes
eve-iac destroy ./lab --yes --no-wipe

eve-iac status¶

Synopsis¶

eve-iac status [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                      [--ca-pem CA_PEM] [--json] [--yes]
                      [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                      [--password PASSWORD] [--lab LAB]
                      project

Description¶

Project runtime status

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac status ./lab

eve-iac inspect¶

Synopsis¶

eve-iac inspect [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                       [--ca-pem CA_PEM] [--json] [--yes]
                       [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                       [--password PASSWORD] [--lab LAB] [--refresh]
                       project

Description¶

Observe the live lab

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--refresh	flag	False	Send refresh=true

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac inspect ./lab
eve-iac inspect ./lab --refresh

eve-iac exec¶

Synopsis¶

eve-iac exec [-h] [--url URL] [--token TOKEN] [--ca-file CA_FILE]
                    [--ca-pem CA_PEM] [--json] [--yes]
                    [--timeout-ms TIMEOUT_MS] [--username USERNAME]
                    [--password PASSWORD] [--lab LAB] [--node NODE]
                    [--stopmode {0,1,2,3}]
                    project {start,stop,wipe}

Description¶

start, stop, or wipe nodes

Arguments¶

Argument	Required	Description
project	yes	Lab directory containing .eve-iac.yml
action	yes

Options¶

Option	Value	Default	Description	Env
--url	URL	omitted (not sent / not set)	HTTPS eve-iac-agent URL (or EVE_IAC_URL)	EVE_IAC_URL
--token	TOKEN	omitted (not sent / not set)	Bearer token (or EVE_IAC_TOKEN)	EVE_IAC_TOKEN
--ca-file	CA-FILE	omitted (not sent / not set)	Pinned CA certificate file (or EVE_IAC_CA_FILE)	EVE_IAC_CA_FILE
--ca-pem	CA-PEM	omitted (not sent / not set)	Pinned CA PEM (or EVE_IAC_CA_PEM)	EVE_IAC_CA_PEM
--json	flag	omitted (not sent / not set)	Write SDK result JSON to stdout
--yes	flag	omitted (not sent / not set)	Confirm destructive operations
--timeout-ms	TIMEOUT-MS	omitted (not sent / not set)	Override the operation timeout
--username	USERNAME	omitted (not sent / not set)	Login username (or EVE_IAC_USERNAME)	EVE_IAC_USERNAME
--password	PASSWORD	omitted (not sent / not set)	Login password (or EVE_IAC_PASSWORD)	EVE_IAC_PASSWORD
--lab	LAB	omitted	Override eve.lab (EVE API path starting with /)
--node	NODE	omitted	IaC node key; omitted means all nodes
--stopmode	0|1|2|3	omitted	Explicit stop mode; omitted stays omitted

Output¶

Human text on stdout by default. --json writes the SDK result object as JSON.

Examples¶

eve-iac exec ./lab start
eve-iac exec ./lab stop
eve-iac exec ./lab wipe --yes
eve-iac exec ./lab start --node n_1