执行各种角色和集合相关的操作。
usage: ansible-galaxy [-h] [--version] [-v] TYPE ...
命令来管理共享存储库中的 Ansible 角色,默认是 Ansible Galaxy https://galaxy.ansible.com。
--version
显示程序的版本号、配置文件位置、配置的模块搜索路径、模块位置、可执行位置和退出
-h
,
--help
显示此帮助信息并退出
-v
,
--verbose
详细模式(-vvv 表示更多,-vvvv 启用连接调试)
对 Ansible Galaxy 集合执行操作。必须与下面列出的 init/install 等进一步操作结合使用。
创建符合 Galaxy 元数据格式的角色或集合的骨架框架。需要角色或集合名称。集合名称必须采用 <namespace>.<collection> 格式。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--collection-skeleton
<COLLECTION_SKELETON>
新集合应基于的集合骨架的路径。
--init-path
<INIT_PATH>
将在其中创建骨架集合的路径。默认为当前工作目录。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-f
,
--force
强制覆盖现有角色或集合
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
构建一个 Ansible Galaxy 集合工件,该工件可以存储在像 Ansible Galaxy 这样的中央存储库中。默认情况下,此命令从当前工作目录构建。您可以选择传入集合输入路径(galaxy.yml 文件所在的位置)。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--output-path
<OUTPUT_PATH>
构建集合的路径。默认为当前工作目录。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-f
,
--force
强制覆盖现有角色或集合
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
将集合发布到 Ansible Galaxy。需要发布集合 tarball 的路径。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--import-timeout
<IMPORT_TIMEOUT>
等待集合导入过程完成的时间。
--no-wait
不要等待导入验证结果。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
安装一个或多个角色(ansible-galaxy 角色安装),或一个或多个集合(ansible-galaxy 集合安装)。您可以传入列表(角色或集合)或使用下面列出的文件选项(这些是互斥的)。如果传入一个列表,它可以是一个名称(将通过galaxy API 和github 下载),也可以是本地tar 存档文件。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--force-with-deps
强制覆盖现有集合及其依赖项。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-f
,
--force
强制覆盖现有角色或集合
-i
,
--ignore-errors
忽略安装过程中的错误并继续下一个指定的集合。这不会忽略依赖冲突错误。
-n
,
--no-deps
不要下载列为依赖项的集合。
-p
<COLLECTIONS_PATH>
,
--collections-path
<COLLECTIONS_PATH>
包含您的集合的目录的路径。
-r
<REQUIREMENTS>
,
--requirements-file
<REQUIREMENTS>
包含要安装的集合列表的文件。
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
对 Ansible Galaxy 角色执行操作。必须与下面列出的删除/安装/初始化等进一步操作结合使用。
创建符合 Galaxy 元数据格式的角色或集合的骨架框架。需要角色或集合名称。集合名称必须采用 <namespace>.<collection> 格式。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--init-path
<INIT_PATH>
将在其中创建骨架角色的路径。默认为当前工作目录。
--offline
创建角色时不要查询galaxy API
--role-skeleton
<ROLE_SKELETON>
新角色应基于的角色骨架的路径。
--type
<ROLE_TYPE>
使用备用角色类型进行初始化。有效类型包括:“容器”、“apb”和“网络”。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-f
,
--force
强制覆盖现有角色或集合
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
从本地系统中删除作为参数传递的角色列表。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
-f
,
--force
强制覆盖现有角色或集合
-p
,
--roles-path
包含您的角色的目录的路径。默认是通过 DEFAULT_ROLES_PATH 配置的第一个可写的: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
从 Ansible Galaxy 中删除角色。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
-f
,
--force
强制覆盖现有角色或集合
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
列出安装在本地系统上的角色或匹配作为参数传递的单个角色。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-p
,
--roles-path
包含您的角色的目录的路径。默认是通过 DEFAULT_ROLES_PATH 配置的第一个可写的: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
在 Ansible Galaxy 服务器上搜索角色
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--author
<AUTHOR>
GitHub 用户名--galaxy-tags <GALAXY
_TAGS>
要过滤的星系标签列表
--platforms
<PLATFORMS>
要过滤的操作系统平台列表
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
用于将角色导入 Ansible Galaxy
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--branch
<REFERENCE>
要导入的分支的名称。默认为存储库的默认分支(通常是 master)
--no-wait
不要等待导入结果。
--role-name
<ROLE_NAME>
角色应该具有的名称,如果与 repo 名称不同
--status
检查给定 github_user/github_repo 的最新导入请求的状态。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
从 Github 或 Travis 为 Ansible Galaxy 角色设置集成
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--list
列出您的所有集成。
--remove
<REMOVE_ID>
删除与提供的ID值匹配的集成。使用-list查看ID值。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-p
,
--roles-path
包含角色的目录的路径。默认值是通过Default_Roles_Path配置的第一个可写的可写:〜/ .Ansible /角色:/ usr / share / Ansible /角色:/ etc / Ansible /角色
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
打印有关已安装角色的详细信息以及从Galaxy API提供的信息。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--offline
创建角色时不要查询Galaxy API
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-p
,
--roles-path
包含角色的目录的路径。默认值是通过Default_Roles_Path配置的第一个可写的可写:〜/ .Ansible /角色:/ usr / share / Ansible /角色:/ etc / Ansible /角色
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
安装一个或多个角色(Ansible-Galaxy角色安装),或一个或多个集合(Ansible-Galaxy Collection Install)。您可以通过列表(角色或集合)或使用下面列出的文件选项(这些是互斥的)。如果您在列表中传递,它可以是名称(将通过Galaxy API和GitHub下载),或者它可以是本地TAR存档文件。
--api-key
<API_KEY>
Ansible Galaxy API 密钥,可在 https://galaxy.ansible.com/me/preferences 找到。您还可以为 GALAXY_SERVER_LIST 条目设置令牌。
--force-with-deps
强制覆盖现有角色及其依赖关系。
-c
,
--ignore-certs
忽略 SSL 证书验证错误。
-f
,
--force
强制覆盖现有角色或集合
-g
,
--keep-scm-meta
在打包角色时,请使用tar而不是SCM归档选项。
-i
,
--ignore-errors
忽略错误并继续下一个指定的角色。
-n
,
--no-deps
不要下载列为依赖项的角色。
-p
,
--roles-path
包含角色的目录的路径。默认值是通过Default_Roles_Path配置的第一个可写的可写:〜/ .Ansible /角色:/ usr / share / Ansible /角色:/ etc / Ansible /角色
-r
<ROLE_FILE>
,
--role-file
<ROLE_FILE>
包含要导入的角色列表的文件。
-s
<API_SERVER>
,
--server
<API_SERVER>
Galaxy API 服务器 URL
可以指定以下环境变量。
ANSIBLE_CONFIG
– 覆盖默认的 ansible 配置文件
ansible.cfg 中的大多数选项还有更多可用选项
/etc/ansible/ansible.cfg
– 配置文件,如果存在则使用
~/.ansible.cfg
– 用户配置文件,如果存在则覆盖默认配置
Ansible 最初由 Michael DeHaan 编写。
有关贡献者的完整列表,请参阅 AUTHORS 文件。
Ansible 是根据 GPLv3+ 许可条款发布的。