Skip to content

Argument Map

HOME_DIR module-attribute

Home Directory

Defaults to users home directory at $HOME/.duplo This is where the cli will look by default for the config and cache as well.

--homedir, --home-dir
The home directory for duplo configurations
Type str
Env $DUPLO_HOME

CACHE_DIR module-attribute

Cache Directory

Defaults to $HOME/.duplo/cache. This is where the cli will store the cached credentials. Sometimes you may need to delete this directory to clear out old credentials. Simply type duploctl and this will print where the cache is currently stored.

--cachedir, --cache-dir
The cache directory for saved credentials.
Type str
Env $DUPLO_CACHE

LOGLEVEL module-attribute

--log-level, --loglevel, -L
The log level to use.
Type str
Default INFO
Env $DUPLO_LOG_LEVEL
CRITICAL FATAL ERROR WARN WARNING INFO DEBUG NOTSET

CONFIG module-attribute

--configfile, --config-file
The path to the duploctl configuration file.
Type str
Env $DUPLO_CONFIG

CONTEXT module-attribute

--context, --ctx
Use the specified context from the config file.
Type str
Env $DUPLO_CONTEXT

HOST module-attribute

--host, -H
The URL to specified Duplo portal.
Type str
Env $DUPLO_HOST

TOKEN module-attribute

--token, -t
The token to authenticate with DuploCloud Portal API.
Type str
Env $DUPLO_TOKEN

TENANT module-attribute

Tenant Name

Scopes the command into the specified tenant. In the background the TENANT_ID is discovered using this name. So if TENANT_ID is set, this is ignored. Often times this is set as an environment variable so you don't have to choose the tenant each and every command. This can also be set in the config file within a context.

--tenant, -T
The tenant name
Type str
Env $DUPLO_TENANT

TENANT_ID module-attribute

Tenant ID

Scopes the command into the specified tenant. This is the internal id of the tenant. If this is set, TENANT name argument is ignored.

--tenantid, --tenant-id, --tid
The tenant id
Type str
Env $DUPLO_TENANT_ID

PLAN module-attribute

Plan Name

Scopes the command to a specific infrastructure plan.

--plan, -P
The plan name.
Type str
Env $DUPLO_PLAN

BODY module-attribute

File Body

This is the file path to a file with the specified resource's body within. Each Resource will have its own schema for the body. This is a YAML/JSON file that will be parsed and used as the body of the request. View the docs for each individual resource to see the schema for the body.

--file, -f, --cli-input
A file to read the input from
Type FileType('r')
Action YamlAction

DATAMAP module-attribute

--fromfile, --from-file, --from-literal
A file or literal value to add to the data map
Type str
Action DataMapAction

DRYRUN module-attribute

--dryrun, --dry-run
Do not submit any changes to the server, just print the data to the console.
Type bool
Action store_true

ARN module-attribute

--aws-arn, --arn
The aws arn
Type str

INTERACTIVE module-attribute

--interactive, -I
Use interactive Login mode for temporary tokens. Do not use with --token.
Type bool
Action store_true

ISADMIN module-attribute

--admin, --isadmin
Request admin access when using interactive login.
Type bool
Action store_true

NOCACHE module-attribute

--no-cache, --nocache
Do not use cache credentials.
Type bool
Action store_true

BROWSER module-attribute

Web Browser

This is the browser of choice to use for interactive login. This is simply using the python webbrowser module to open the browser. If you don't have a browser installed, you can use w3m or lynx for a text based browser.

--web-browser, --browser
The desired web browser to use for interactive login
Type str
Env $DUPLO_BROWSER
chrome chromium firefox safari epiphany edge opera konqueror kfm w3m lynx

OUTPUT module-attribute

--output, -o
The output format
Type str
Default json
Env $DUPLO_OUTPUT
env string json yaml csv

QUERY module-attribute

--query, -q
The jmespath query to run on a result
Type str

PATCHES module-attribute

--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
Type str
Action JsonPatchAction

EXCLUDE module-attribute

--exclude, --exclude
Exclude from the command
Type str
Action append

SERVICE module-attribute

service positional
The service to run
Type str
argo_wf batch_queue ecs jit ssm_param batch_scheduling_policy secret storageclass ingress batch_definition aws_secret cronjob hosts tenant batch_compute cache configmap infrastructure s3 service rds argo_wf_template pod pvc version batch_job user job plan cloudfront ai lambda system asg

COMMAND module-attribute

command positional
The subcommand to run
Type str

NAME module-attribute

name positional
The resource name
Type str
Nargs ?

DISTRIBUTION_ID module-attribute

distribution_id positional
The distribution id
Type str
Nargs ?

IMAGE module-attribute

image positional
The image to use
Type str
Nargs ?

S3BUCKET module-attribute

bucket positional
The s3 bucket to use
Type str

S3KEY module-attribute

key positional
The s3 key to use
Type str

HEALTH_CHECK_URL module-attribute

--health-check-url, --health-check-url
The health check URL
Type str

TO_REVISION module-attribute

--revision, --to-revision
The revision to rollback to
Type int

CONTAINER_PORT module-attribute

--container-port, --container-port
Container port
Type str

CONTAINER module-attribute

--container, --container, -C
The container name
Type str

CONTAINER_IMAGE module-attribute

--container-image, --container-image <key> <value>
a key and value to set as a side-car container name and image
Type str
Action append
Nargs 2

INIT_CONTAINER_IMAGE module-attribute

--init-container-image, --init-container-image <key> <value>
a key and value to set as an init container name and image
Type str
Action append
Nargs 2

EXTERNAL_PORT module-attribute

--external-port, --external-port
The external port
Type str

PROTOCOL module-attribute

--protocol, --protocol
The protocol
Type str
http https tcp udp tls

LOAD_BALANCER_TYPE module-attribute

--lb-type, --lb-type
The type of load balancer. Valid options are [applicationlb, k8clusterip, k8nodeport, networklb, targetgrouponly].
Type str
applicationlb k8clusterip k8nodeport networklb targetgrouponly

LOAD_BALANCER_VISIBILITY module-attribute

--visibility, --visibility
The visibility of load balancer. Valid options are "public" or "private". Default is public.
Type str
Default public
public private

LOAD_BALANCER_MODE module-attribute

--mode, --mode
The mode of load balancer. Valid options are "docker-mode" or "native-app". Default is docker-mode.
Type str
Default docker-mode
docker-mode native-app

SERVICEIMAGE module-attribute

--serviceimage, -S <service> <image>
takes two arguments, a service name and an image:tag
Type str
Action append
Nargs 2

SETVAR module-attribute

--setvar, -V <key> <value>
a key and value to set as an environment variable
Type str
Action append
Nargs 2

STRATEGY module-attribute

--strategy, -strat
The merge strategy to use. Valid options are "merge" or "replace". Default is merge.
Type str
Default merge
merge replace

DELETEVAR module-attribute

--deletevar, -D
a key to delete from the environment variables
Type str
Action append

SCHEDULE module-attribute

--schedule, -s
The schedule to use
Type str

CRONSCHEDULE module-attribute

cronschedule positional
The schedule to use
Type str

ENABLE module-attribute

--enable, -y
Enable or disable the feature
Type bool
Action BooleanOptionalAction

MIN module-attribute

--min, -m
The minimum number of replicas
Type int

MAX module-attribute

--max, -M
The maximum number of replicas
Type int

REPLICAS module-attribute

--replicas, -r
Number of replicas for service
Type int

WAIT module-attribute

--wait, -w
Wait for the operation to complete
Type bool
Action store_true

STREAM module-attribute

--stream, --stream
Stream the response (follow live output until complete)
Type bool
Action store_true

VALIDATE module-attribute

--validate, --validate
Validate body inputs against the SDK model schema.
Type bool
Env $DUPLO_VALIDATE
Action store_true

WAIT_TIMEOUT module-attribute

--wait_timeout, --wait-timeout, --timeout
Wait timeout for the operation to complete
Type int

ALL module-attribute

--all, --all
Boolean flag to select all. Defaults to False.
Type bool
Action store_true

SIZE module-attribute

size positional
The instance size to use
Type str

SAVE_SECRET module-attribute

--save-secret, --save
Save the secret to secrets manager.
Type bool
Action store_true

PASSWORD module-attribute

password positional
The password to use
Type str

INTERVAL module-attribute

interval positional
The monitoring interval to use
Type int
1 5 10 15 30 60

IMMEDIATE module-attribute

--immediate, -i
Apply the change immediately
Type bool
Action store_true

TARGET module-attribute

--target, --target-name
The target name to use
Type str

TARGETS module-attribute

--targets, --targets
The list of targets
Type str
Nargs +

TIME module-attribute

--time, --time
The time to use
Type str

TITLE module-attribute

--title, --title required
The Title for ticket
Type str

AGENTNAME module-attribute

--agent_name, --agent_name, --agent required
AI Agent to be used to process the ticket
Type str

INSTANCEID module-attribute

--instance_id, --instance_id, --instance required
AI Agent Instance Id
Type str

APIVERSION module-attribute

--api_version, --api-version
API Version
Type str
Default v1

TICKETID module-attribute

--ticket_id, --ticket_id, --ticket required
The ID of the AI HelpDesk ticket
Type str

MESSAGE module-attribute

--message, --content, --msg, --message
The message you want to send to the AI agent
Type str

HELPDESK_ORIGIN module-attribute

--helpdesk_origin, --helpdesk-origin, --origin
The helpdesk origin to use for the ticket
Type str

DAYS module-attribute

days positional
The days to use
Type int

CONTENT_DIR module-attribute

--content, --content-dir
The content directory for a website.
Type str
Default dist
Env $DUPLO_CONTENT

SSM_PARAM_TYPE module-attribute

--parametertype, -ptype
The type of parameter to create
Type str
Default String
String StringList SecureString

CONTENT module-attribute

--parametervalue, -pval, -val, --value
Arbitrary text to add as the content of some secret or configuration paramater.
Type str

SHOW_SENSITIVE module-attribute

--showsensitive, -show
Return sensitive values to output. WARNING - ENABLING THIS SETTING MAY DISPLAY SENSITIVE DATA TO STDOUT/LOG FILES
Type bool
Action store_true

BATCH_QUEUE module-attribute

--queue, -BQ, -bq, --batch-queue
The name of a Batch Queue
Type str
Env $DUPLO_BATCH_QUEUE

ALLOCATION_TAGS module-attribute

allocationtags positional
Allocation tag used to specify custom allocation rules
Type str