.TH "GCLOUD_ALPHA_COMPOSER_ENVIRONMENTS_RUN" 1



.SH "NAME"
.HP
gcloud alpha composer environments run \- run an Airflow sub\-command remotely in a Cloud Composer environment



.SH "SYNOPSIS"
.HP
\f5gcloud alpha composer environments run\fR (\fIENVIRONMENT\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fISUBCOMMAND\fR [\fISUBCOMMAND_NESTED\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR] [\-\-\ \fICMD_ARGS\fR\ ...]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Executes an Airflow CLI sub\-command remotely in an environment.
If the sub\-command takes flags, separate the environment name from the
sub\-command and its flags with ``\-\-''. This command waits for the
sub\-command to complete; its exit code will match the sub\-command's exit code.

Note: Airflow CLI sub\-command syntax differs between Airflow 1 and Airflow 2.
Refer to the Airflow CLI reference documentation for more details.



.SH "EXAMPLES"

The following command in environments with Airflow 2:

.RS 2m
gcloud alpha composer environments run myenv dags trigger \-\- some_dag \-\-run_id=foo
.RE

is equivalent to running the following command from a shell inside the
\fBmy\-environment\fR environment:

.RS 2m
airflow dags trigger \-\-run_id=foo some_dag
.RE

The same command, but for environments with Airflow 1.10.14+:

.RS 2m
gcloud alpha composer environments run myenv trigger_dag \-\- some_dag \-\-run_id=foo
.RE

is equivalent to running the following command from a shell inside the
\fBmy\-environment\fR environment:

.RS 2m
airflow trigger_dag some_dag \-\-run_id=foo
.RE

The following command (for environments with Airflow 1.10.14+):

.RS 2m
gcloud alpha composer environments run myenv dags list
.RE

is equivalent to running the following command from a shell inside the
\fBmy\-environment\fR environment:

.RS 2m
airflow dags list
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Environment resource \- The environment in which to run an Airflow command. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIENVIRONMENT\fR

ID of the environment or fully qualified identifier for the environment.

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Region where Composer environment runs or in which to create the environment.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5composer/location\fR.
.RE
.sp

.RE
.sp
.TP 2m
\fISUBCOMMAND\fR

The Airflow CLI subcommand to run. Available subcommands include (listed with
Airflow versions that support): backfill [**, 2.0.0), clear [**, 2.0.0),
connections [**, 3.2.0), dag_state [**, 2.0.0), dags [1.10.14, 3.2.0), db
[2.3.0, 3.0.0), delete_dag [1.10.1, 2.0.0), kerberos [**, 3.2.0), kubernetes
[2.1.4, 3.2.0), list\-import\-errors [**, 3.0.0), list_dag_runs [1.10.2, 2.0.0),
list_dags [**, 2.0.0), list_tasks [**, 2.0.0), next_execution [1.10.2, 2.0.0),
pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, 3.2.0), render [**, 2.0.0),
roles [2.0.0, 3.2.0), run [**, 2.0.0), sync\-perm [1.10.14, 3.2.0), sync_perm
[1.10.2, 2.0.0), task_failed_deps [**, 2.0.0), task_state [**, 2.0.0), tasks
[1.10.14, 3.2.0), test [**, 2.0.0), trigger_dag [**, 2.0.0), unpause [**,
2.0.0), upgrade_check [1.10.15, 2.0.0), users [1.10.14, 3.2.0), variables [**,
3.2.0), version [**, 3.2.0) (see
https://airflow.apache.org/docs/apache\-airflow/stable/cli\-and\-env\-variables\-ref.html
for more info).

.TP 2m
[\fISUBCOMMAND_NESTED\fR]

Additional subcommand in case it is nested. The following is a list of allowed
nested subcommands:
.RS 2m
.IP "\(em" 2m
db: check, trim
.IP "\(em" 2m
all other subcommands: all nested subcommands are allowed
.RE
.sp

.TP 2m
[\-\- \fICMD_ARGS\fR ...]

Command line arguments to the subcommand.

The '\-\-' argument must be specified between gcloud specific args on the left
and CMD_ARGS on the right. Example:

gcloud alpha composer environments run myenv trigger_dag \-\- some_dag
\-\-run_id=foo


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud composer environments run
.RE

.RS 2m
$ gcloud beta composer environments run
.RE