FAB CLI 命令¶
注意
以下 CLI 命令来源于 Airflow 2.9.0+ 的 FAB 提供程序。此前，它们是 Airflow 核心的一部分，因此，如果您使用的是低于 2.9.0 的 Airflow 版本，请参阅 Airflow 核心文档以获取可用 CLI 命令和参数列表。
Usage: airflow [-h] GROUP_OR_COMMAND ...
位置参数¶
- GROUP_OR_COMMAND
可能的选择：users、roles、sync-perm
子命令¶
users¶
管理用户
airflow users [-h] COMMAND ...
位置参数¶
- COMMAND
可能的选择：add-role、create、delete、export、import、list、remove-role、reset-password
子命令¶
add-role¶
向用户添加角色
airflow users add-role [-h] [-e EMAIL] -r ROLE [-u USERNAME] [-v]
命名参数¶
- -e, --email
用户的电子邮件地址
- -r, --role
用户的角色。现有角色包括管理员、用户、运维人员、查看者和公共用户
- -u, --username
用户的用户名
- -v, --verbose
使日志输出更加详细
默认值：False
create¶
创建用户
airflow users create [-h] -e EMAIL -f FIRSTNAME -l LASTNAME [-p PASSWORD] -r
ROLE [--use-random-password] -u USERNAME [-v]
命名参数¶
- -e, --email
用户的电子邮件地址
- -f, --firstname
用户的姓氏
- -l, --lastname
用户的名字
- -p, --password
用户的密码，如果未指定 –use-random-password，则必须提供
- -r, --role
用户的角色。现有角色包括管理员、用户、运维人员、查看者和公共用户
- --use-random-password
不提示输入密码。改用随机字符串。如果未指定 –password，则必须提供
默认值：False
- -u, --username
用户的用户名
- -v, --verbose
使日志输出更加详细
默认值：False
示例：要创建具有“管理员”角色且用户名为“admin”的用户，请运行
- $ airflow users create
–username admin –firstname FIRST_NAME –lastname LAST_NAME –role Admin –email admin@example.org
delete¶
删除用户
airflow users delete [-h] [-e EMAIL] [-u USERNAME] [-v]
命名参数¶
- -e, --email
用户的电子邮件地址
- -u, --username
用户的用户名
- -v, --verbose
使日志输出更加详细
默认值：False
export¶
导出所有用户
airflow users export [-h] [-v] FILEPATH
位置参数¶
- FILEPATH
将所有用户导出到 JSON 文件
命名参数¶
- -v, --verbose
使日志输出更加详细
默认值：False
import¶
导入用户
airflow users import [-h] [-v] FILEPATH
位置参数¶
- FILEPATH
从 JSON 文件导入用户。示例格式
[ { "email": "[email protected]", "firstname": "Jon", "lastname": "Doe", "roles": ["Public"], "username": "jondoe" } ]
命名参数¶
- -v, --verbose
使日志输出更加详细
默认值：False
list¶
列出用户
airflow users list [-h] [-o table, json, yaml, plain] [-v]
命名参数¶
- -o, --output
可能的选择：table、json、yaml、plain
输出格式。允许的值：json、yaml、plain、table（默认值：table）
默认值：“table”
- -v, --verbose
使日志输出更加详细
默认值：False
remove-role¶
从用户中删除角色
airflow users remove-role [-h] [-e EMAIL] -r ROLE [-u USERNAME] [-v]
命名参数¶
- -e, --email
用户的电子邮件地址
- -r, --role
用户的角色。现有角色包括管理员、用户、运维人员、查看者和公共用户
- -u, --username
用户的用户名
- -v, --verbose
使日志输出更加详细
默认值：False
reset-password¶
重置用户的密码
airflow users reset-password [-h] [-e EMAIL] [-p PASSWORD]
[--use-random-password] [-u USERNAME] [-v]
命名参数¶
- -e, --email
用户的电子邮件地址
- -p, --password
用户的密码，如果未指定 –use-random-password，则必须提供
- --use-random-password
不提示输入密码。改用随机字符串。如果未指定 –password，则必须提供
默认值：False
- -u, --username
用户的用户名
- -v, --verbose
使日志输出更加详细
默认值：False
示例：要重置用户名为“admin”的用户，请运行
- $ airflow users reset-password
–username admin
roles¶
管理角色
airflow roles [-h] COMMAND ...
位置参数¶
- COMMAND
可能的选择：add-perms、create、del-perms、delete、export、import、list
子命令¶
add-perms¶
添加角色权限
airflow roles add-perms [-h] -a [ACTION [ACTION ...]] -r
[RESOURCE [RESOURCE ...]] [-v]
[role [role ...]]
位置参数¶
- role
角色名称
命名参数¶
- -a, --action
权限的操作
- -r, --resource
权限的名称
- -v, --verbose
使日志输出更加详细
默认值：False
create¶
创建角色
airflow roles create [-h] [-v] [role [role ...]]
位置参数¶
- role
角色名称
命名参数¶
- -v, --verbose
使日志输出更加详细
默认值：False
del-perms¶
删除角色权限
airflow roles del-perms [-h] [-a [ACTION [ACTION ...]]] -r
[RESOURCE [RESOURCE ...]] [-v]
[role [role ...]]
位置参数¶
- role
角色名称
命名参数¶
- -a, --action
权限的操作
- -r, --resource
权限的名称
- -v, --verbose
使日志输出更加详细
默认值：False
delete¶
删除角色
airflow roles delete [-h] [-v] [role [role ...]]
位置参数¶
- role
角色名称
命名参数¶
- -v, --verbose
使日志输出更加详细
默认值：False
export¶
将角色（不含权限）从数据库导出到 JSON 文件
airflow roles export [-h] [-p] [-v] file
位置参数¶
- file
将所有角色导出到 JSON 文件
命名参数¶
- -p, --pretty
通过对角色名称进行排序并使用 4 个空格缩进，来格式化输出的 JSON 文件
默认值：False
- -v, --verbose
使日志输出更加详细
默认值：False