参考指南¶

awx activity_stream¶

usage: awx activity_stream [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx activity_stream get¶

usage: awx activity_stream get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx activity_stream list¶

usage: awx activity_stream list [-h] [--all] [--order_by ORDER_BY]
                                [-f {json,yaml,jq,human}] [--filter TEXT]
                                [--conf.color BOOLEAN] [-v]
                                [--type {activity_stream}]
                                [--timestamp TIMESTAMP]
                                [--operation {create,update,delete,associate,disassociate}]
                                [--changes JSON/YAML] [--object1 TEXT]
                                [--object2 TEXT] [--action_node TEXT]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {activity_stream}¶

仅列出具有指定类型的 activity_stream

--timestamp <timestamp>¶

仅列出具有指定时间戳的 activity_stream

--operation {create,update,delete,associate,disassociate}¶

仅列出具有指定操作的 activity_stream

--changes <json/yaml>¶

仅列出具有指定更改的 activity_stream

--object1 <text>¶

仅列出具有指定 object1 的 activity_stream

--object2 <text>¶

仅列出具有指定 object2 的 activity_stream

--action_node <text>¶

仅列出具有指定 action_node 的 activity_stream

awx ad_hoc_commands¶

usage: awx ad_hoc_commands [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx ad_hoc_commands create¶

usage: awx ad_hoc_commands create [-h] [--monitor]
                                  [--action-timeout ACTION_TIMEOUT] [--wait]
                                  [--interval INTERVAL]
                                  [--execution_environment ID]
                                  [--job_type {run,check}] --inventory ID
                                  [--limit TEXT] --credential ID
                                  [--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}]
                                  [--module_args TEXT] [--forks INTEGER]
                                  [--verbosity {0,1,2,3,4,5}]
                                  [--extra_vars TEXT]
                                  [--become_enabled BOOLEAN]
                                  [--diff_mode BOOLEAN]

-h, --help¶

显示此帮助消息并退出

--monitor¶

如果设置，则打印已启动作业的标准输出，直到它完成。

--action-timeout <action_timeout>¶

如果与 –monitor 或 –wait 一起设置，则等待作业完成超时。

--wait¶

如果设置，则等待已启动作业完成。

--interval <interval>¶

如果与 –monitor 或 –wait 一起设置，则在 API 调用之间等待的时间（以秒为单位）。最小值为 2.5 秒，以避免压倒 API

--execution_environment <id>¶

要用于执行的容器映像。

--job_type {run,check}¶

--inventory <id>¶

关联的清单的 ID

--limit <text>¶

--credential <id>¶

关联的凭据的 ID

--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}¶

--module_args <text>¶

--forks <integer>¶

--verbosity {0,1,2,3,4,5}¶

--extra_vars <text>¶

--become_enabled <boolean>¶

--diff_mode <boolean>¶

awx ad_hoc_commands delete¶

usage: awx ad_hoc_commands delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx ad_hoc_commands get¶

usage: awx ad_hoc_commands get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx ad_hoc_commands list¶

usage: awx ad_hoc_commands list [-h] [--all] [--order_by ORDER_BY]
                                [-f {json,yaml,jq,human}] [--filter TEXT]
                                [--conf.color BOOLEAN] [-v]
                                [--type {ad_hoc_command}] [--created CREATED]
                                [--modified MODIFIED] [--name TEXT]
                                [--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}]
                                [--status {new,pending,waiting,running,successful,failed,error,canceled}]
                                [--execution_environment ID]
                                [--failed BOOLEAN] [--started STARTED]
                                [--finished FINISHED]
                                [--canceled_on CANCELED_ON]
                                [--elapsed ELAPSED] [--job_explanation TEXT]
                                [--execution_node TEXT]
                                [--controller_node TEXT] [--work_unit_id TEXT]
                                [--job_type {run,check}] [--inventory ID]
                                [--limit TEXT] [--credential ID]
                                [--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}]
                                [--module_args TEXT] [--forks INTEGER]
                                [--verbosity {0,1,2,3,4,5}]
                                [--extra_vars TEXT] [--become_enabled BOOLEAN]
                                [--diff_mode BOOLEAN]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {ad_hoc_command}¶

仅列出指定类型的 ad_hoc_commands

--created <created>¶

仅列出指定创建时间的 ad_hoc_commands

--modified <modified>¶

仅列出指定修改时间的 ad_hoc_commands

--name <text>¶

仅列出指定名称的 ad_hoc_commands

--launch_type {manual,relaunch,callback,scheduled,dependency,workflow,webhook,sync,scm}¶

仅列出指定 launch_type 的 ad_hoc_commands

--status {new,pending,waiting,running,successful,failed,error,canceled}¶

仅列出指定状态的 ad_hoc_commands

--execution_environment <id>¶

仅列出指定 execution_environment 的 ad_hoc_commands

--failed <boolean>¶

仅列出指定 failed 的 ad_hoc_commands

--started <started>¶

仅列出指定 started 的 ad_hoc_commands

--finished <finished>¶

仅列出指定 finished 的 ad_hoc_commands

--canceled_on <canceled_on>¶

仅列出指定 canceled_on 的 ad_hoc_commands

--elapsed <elapsed>¶

仅列出指定 elapsed 的 ad_hoc_commands

--job_explanation <text>¶

仅列出指定 job_explanation 的 ad_hoc_commands

--execution_node <text>¶

仅列出指定 execution_node 的 ad_hoc_commands

--controller_node <text>¶

仅列出指定 controller_node 的 ad_hoc_commands

--work_unit_id <text>¶

仅列出指定 work_unit_id 的 ad_hoc_commands

--job_type {run,check}¶

仅列出指定 job_type 的 ad_hoc_commands

--inventory <id>¶

仅列出指定 inventory 的 ad_hoc_commands

--limit <text>¶

仅列出指定 limit 的 ad_hoc_commands

--credential <id>¶

仅列出指定 credential 的 ad_hoc_commands

--module_name {command,shell,yum,apt,apt_key,apt_repository,apt_rpm,service,group,user,mount,ping,selinux,setup,win_ping,win_service,win_updates,win_group,win_user}¶

仅列出指定 module_name 的 ad_hoc_commands

--module_args <text>¶

仅列出指定 module_args 的 ad_hoc_commands

--forks <integer>¶

仅列出指定 forks 的 ad_hoc_commands

--verbosity {0,1,2,3,4,5}¶

仅列出指定 verbosity 的 ad_hoc_commands

--extra_vars <text>¶

仅列出指定 extra_vars 的 ad_hoc_commands

--become_enabled <boolean>¶

仅列出指定 become_enabled 的 ad_hoc_commands

--diff_mode <boolean>¶

仅列出指定 diff_mode 的 ad_hoc_commands

awx ad_hoc_commands stdout¶

usage: awx ad_hoc_commands stdout [-h] id

id¶

-h, --help¶

显示此帮助消息并退出

awx analytics¶

usage: awx analytics [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx analytics get¶

usage: awx analytics get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                         [--conf.color BOOLEAN] [-v]
                         id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx analytics list¶

usage: awx analytics list [-h] [--all] [--order_by ORDER_BY]
                          [-f {json,yaml,jq,human}] [--filter TEXT]
                          [--conf.color BOOLEAN] [-v]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx applications¶

usage: awx applications [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx applications create¶

usage: awx applications create [-h] --name TEXT [--description TEXT]
                               --client_type {confidential,public}
                               [--redirect_uris TEXT]
                               --authorization_grant_type
                               {authorization-code,password}
                               [--skip_authorization BOOLEAN] --organization
                               ID

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该应用程序的名称。

--description <text>¶

该应用程序的可选描述。

--client_type {confidential,public}¶

根据客户端设备的安全性设置为公共或机密。

--redirect_uris <text>¶

允许的 URI 列表，空格分隔

--authorization_grant_type {authorization-code,password}¶

用户必须使用此应用程序获取令牌的授权类型。

--skip_authorization <boolean>¶

对于完全可信的应用程序，设置为 True 以跳过授权步骤。

--organization <id>¶

包含此应用程序的组织。

awx applications delete¶

usage: awx applications delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx applications get¶

usage: awx applications get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v]
                            id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx applications list¶

usage: awx applications list [-h] [--all] [--order_by ORDER_BY]
                             [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v]
                             [--type {o_auth2_application}]
                             [--created CREATED] [--name TEXT]
                             [--description TEXT] [--client_id TEXT]
                             [--client_secret TEXT]
                             [--client_type {confidential,public}]
                             [--redirect_uris TEXT]
                             [--authorization_grant_type {authorization-code,password}]
                             [--skip_authorization BOOLEAN]
                             [--organization ID]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {o_auth2_application}¶

仅列出指定类型的应用程序

--created <created>¶

仅列出指定创建时间的应用程序

--name <text>¶

仅列出指定名称的应用程序

--description <text>¶

仅列出指定描述的应用程序

--client_id <text>¶

仅列出指定 client_id 的应用程序

--client_secret <text>¶

仅列出指定 client_secret 的应用程序

--client_type {confidential,public}¶

仅列出指定 client_type 的应用程序

--redirect_uris <text>¶

仅列出指定 redirect_uris 的应用程序

--authorization_grant_type {authorization-code,password}¶

仅列出指定 authorization_grant_type 的应用程序

--skip_authorization <boolean>¶

仅列出指定 skip_authorization 的应用程序

--organization <id>¶

仅列出指定组织的应用程序

awx applications modify¶

usage: awx applications modify [-h] [--name TEXT] [--description TEXT]
                               [--client_type {confidential,public}]
                               [--redirect_uris TEXT]
                               [--authorization_grant_type {authorization-code,password}]
                               [--skip_authorization BOOLEAN]
                               [--organization ID]
                               id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该应用程序的名称。

--description <text>¶

该应用程序的可选描述。

--client_type {confidential,public}¶

根据客户端设备的安全性设置为公共或机密。

--redirect_uris <text>¶

允许的 URI 列表，空格分隔

--authorization_grant_type {authorization-code,password}¶

用户必须使用此应用程序获取令牌的授权类型。

--skip_authorization <boolean>¶

对于完全可信的应用程序，设置为 True 以跳过授权步骤。

--organization <id>¶

包含此应用程序的组织。

awx bulk¶

usage: awx bulk [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx bulk get¶

usage: awx bulk get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                    [--conf.color BOOLEAN] [-v]
                    id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx bulk host_create¶

usage: awx bulk host_create [-h] --inventory ID --hosts HOSTS

-h, --help¶

显示此帮助消息并退出

--inventory <id>¶

将主机添加到清单的 主键 ID。

--hosts <hosts>¶

要创建的主机列表，JSON 格式。例如：[{“name”: “example.com”}, {“name”: “127.0.0.1”}]

awx bulk host_delete¶

usage: awx bulk host_delete [-h] --hosts HOSTS

-h, --help¶

显示此帮助消息并退出

--hosts <hosts>¶

要删除的主机 ID 列表，例如：[105, 130, 131, 200]

awx bulk job_launch¶

usage: awx bulk job_launch [-h] [--monitor] [--action-timeout ACTION_TIMEOUT]
                           [--wait] [--interval INTERVAL] [--name TEXT] --jobs
                           JOBS [--description TEXT] [--extra_vars JSON/YAML]
                           [--organization ID] [--inventory ID] [--limit TEXT]
                           [--scm_branch TEXT] [--skip_tags TEXT]
                           [--job_tags TEXT]

-h, --help¶

显示此帮助消息并退出

--monitor¶

如果设置，则打印已启动作业的标准输出，直到它完成。

--action-timeout <action_timeout>¶

如果与 –monitor 或 –wait 一起设置，则等待作业完成超时。

--wait¶

如果设置，则等待已启动作业完成。

--interval <interval>¶

如果与 –monitor 或 –wait 一起设置，则在 API 调用之间等待的时间（以秒为单位）。最小值为 2.5 秒，以避免压倒 API

--name <text>¶

此工作流作业的名称。

--jobs <jobs>¶

要启动的作业列表，JSON 格式。例如：[{“unified_job_template”: 7}, {“unified_job_template”: 10}]

--description <text>¶

此工作流作业的可选描述。

--extra_vars <json/yaml>¶

JSON 或 YAML 字符串。您可以选择指定文件路径，例如：@path/to/file.yml

--organization <id>¶

从该组织继承权限。如果没有提供，将自动选择用户是成员的组织。

--inventory <id>¶

关联的清单的 ID

--limit <text>¶

--scm_branch <text>¶

--skip_tags <text>¶

--job_tags <text>¶

awx bulk list¶

usage: awx bulk list [-h] [--all] [--order_by ORDER_BY]
                     [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx config¶

usage: awx config [-h]

-h, --help¶

显示此帮助消息并退出

awx constructed_inventory¶

usage: awx constructed_inventory [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx constructed_inventory create¶

usage: awx constructed_inventory create [-h] --name TEXT [--description TEXT]
                                        --organization ID
                                        [--variables JSON/YAML]
                                        [--prevent_instance_group_fallback BOOLEAN]
                                        [--source_vars TEXT]
                                        [--update_cache_timeout INTEGER]
                                        [--limit TEXT] [--verbosity INTEGER]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该清单的名称。

--description <text>¶

此清单的可选描述。

--organization <id>¶

包含此清单的组织。

--variables <json/yaml>¶

清单变量，以 JSON 或 YAML 格式显示。可以选择指定文件路径，例如：@path/to/file.yml

--prevent_instance_group_fallback <boolean>¶

如果启用，清单将阻止将任何组织实例组添加到首选实例组列表中，以在其上运行关联的作业模板。如果启用此设置，并且您提供了空列表，则将应用全局实例组。

--source_vars <text>¶

与自动创建的清单源相关的 source_vars，专用于构造的清单。

--update_cache_timeout <integer>¶

与自动创建的清单源相关的缓存超时，专用于构造的清单

--limit <text>¶

限制与自动创建的清单源相关的返回主机的限制，专用于构造的清单。

--verbosity <integer>¶

与自动创建的清单源相关的详细程度级别，专用于构造的清单

awx constructed_inventory delete¶

usage: awx constructed_inventory delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx constructed_inventory get¶

usage: awx constructed_inventory get [-h] [-f {json,yaml,jq,human}]
                                     [--filter TEXT] [--conf.color BOOLEAN]
                                     [-v]
                                     id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx constructed_inventory list¶

usage: awx constructed_inventory list [-h] [--all] [--order_by ORDER_BY]
                                      [-f {json,yaml,jq,human}]
                                      [--filter TEXT] [--conf.color BOOLEAN]
                                      [-v] [--type {inventory}]
                                      [--created CREATED]
                                      [--modified MODIFIED] [--name TEXT]
                                      [--description TEXT] [--organization ID]
                                      [--kind {,smart,constructed}]
                                      [--variables JSON/YAML]
                                      [--has_active_failures BOOLEAN]
                                      [--total_hosts INTEGER]
                                      [--hosts_with_active_failures INTEGER]
                                      [--total_groups INTEGER]
                                      [--has_inventory_sources BOOLEAN]
                                      [--total_inventory_sources INTEGER]
                                      [--inventory_sources_with_failures INTEGER]
                                      [--pending_deletion BOOLEAN]
                                      [--prevent_instance_group_fallback BOOLEAN]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {inventory}¶

仅列出指定类型的 constructed_inventory

--created <created>¶

仅列出具有指定创建时间的 constructed_inventory。

--modified <modified>¶

仅列出具有指定修改时间的 constructed_inventory。

--name <text>¶

仅列出具有指定名称的 constructed_inventory。

--description <text>¶

仅列出具有指定描述的 constructed_inventory。

--organization <id>¶

仅列出具有指定组织的 constructed_inventory。

--kind {,smart,constructed}¶

仅列出具有指定类型的 constructed_inventory。

--variables <json/yaml>¶

仅列出具有指定变量的 constructed_inventory。

--has_active_failures <boolean>¶

仅列出具有指定 has_active_failures 的 constructed_inventory。

--total_hosts <integer>¶

仅列出具有指定 total_hosts 的 constructed_inventory。

--hosts_with_active_failures <integer>¶

仅列出具有指定 hosts_with_active_failures 的 constructed_inventory。

--total_groups <integer>¶

仅列出具有指定 total_groups 的 constructed_inventory。

--has_inventory_sources <boolean>¶

仅列出具有指定 has_inventory_sources 的 constructed_inventory。

--total_inventory_sources <integer>¶

仅列出具有指定 total_inventory_sources 的 constructed_inventory。

--inventory_sources_with_failures <integer>¶

仅列出具有指定 inventory_sources_with_failures 的 constructed_inventory。

--pending_deletion <boolean>¶

仅列出具有指定 pending_deletion 的 constructed_inventory。

--prevent_instance_group_fallback <boolean>¶

仅列出具有指定 prevent_instance_group_fallback 的 constructed_inventory。

awx constructed_inventory modify¶

usage: awx constructed_inventory modify [-h] [--name TEXT]
                                        [--description TEXT]
                                        [--organization ID]
                                        [--variables JSON/YAML]
                                        [--prevent_instance_group_fallback BOOLEAN]
                                        [--source_vars TEXT]
                                        [--update_cache_timeout INTEGER]
                                        [--limit TEXT] [--verbosity INTEGER]
                                        id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该清单的名称。

--description <text>¶

此清单的可选描述。

--organization <id>¶

包含此清单的组织。

--variables <json/yaml>¶

清单变量，以 JSON 或 YAML 格式显示。可以选择指定文件路径，例如：@path/to/file.yml

--prevent_instance_group_fallback <boolean>¶

如果启用，清单将阻止将任何组织实例组添加到首选实例组列表中，以在其上运行关联的作业模板。如果启用此设置，并且您提供了空列表，则将应用全局实例组。

--source_vars <text>¶

与自动创建的清单源相关的 source_vars，专用于构造的清单。

--update_cache_timeout <integer>¶

与自动创建的清单源相关的缓存超时，专用于构造的清单

--limit <text>¶

限制与自动创建的清单源相关的返回主机的限制，专用于构造的清单。

--verbosity <integer>¶

与自动创建的清单源相关的详细程度级别，专用于构造的清单

awx credential_input_sources¶

usage: awx credential_input_sources [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx credential_input_sources create¶

usage: awx credential_input_sources create [-h] [--description TEXT]
                                           --input_field_name TEXT
                                           [--metadata JSON/YAML]
                                           --target_credential ID
                                           --source_credential ID

-h, --help¶

显示此帮助消息并退出

--description <text>¶

此凭证输入源的可选描述。

--input_field_name <text>¶

--metadata <json/yaml>¶

JSON 或 YAML 字符串。您可以选择指定文件路径，例如：@path/to/file.yml

--target_credential <id>¶

关联的 target_credential 的 ID。

--source_credential <id>¶

关联的 source_credential 的 ID。

awx credential_input_sources delete¶

usage: awx credential_input_sources delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx credential_input_sources get¶

usage: awx credential_input_sources get [-h] [-f {json,yaml,jq,human}]
                                        [--filter TEXT] [--conf.color BOOLEAN]
                                        [-v]
                                        id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx credential_input_sources list¶

usage: awx credential_input_sources list [-h] [--all] [--order_by ORDER_BY]
                                         [-f {json,yaml,jq,human}]
                                         [--filter TEXT]
                                         [--conf.color BOOLEAN] [-v]
                                         [--type {credential_input_source}]
                                         [--created CREATED]
                                         [--modified MODIFIED]
                                         [--description TEXT]
                                         [--input_field_name TEXT]
                                         [--metadata JSON/YAML]
                                         [--target_credential ID]
                                         [--source_credential ID]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {credential_input_source}¶

仅列出指定类型的 credential_input_sources

--created <created>¶

仅列出指定创建时间的 credential_input_sources

--modified <modified>¶

仅列出指定修改时间的 credential_input_sources

--description <text>¶

仅列出指定描述的 credential_input_sources

--input_field_name <text>¶

仅列出指定 input_field_name 的 credential_input_sources

--metadata <json/yaml>¶

仅列出指定元数据的 credential_input_sources

--target_credential <id>¶

仅列出指定目标凭证的 credential_input_sources

--source_credential <id>¶

仅列出指定来源凭证的 credential_input_sources

awx credential_input_sources modify¶

usage: awx credential_input_sources modify [-h] [--description TEXT]
                                           [--input_field_name TEXT]
                                           [--metadata JSON/YAML]
                                           [--target_credential ID]
                                           [--source_credential ID]
                                           id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--description <text>¶

此凭证输入源的可选描述。

--input_field_name <text>¶

--metadata <json/yaml>¶

JSON 或 YAML 字符串。您可以选择指定文件路径，例如：@path/to/file.yml

--target_credential <id>¶

关联的 target_credential 的 ID。

--source_credential <id>¶

关联的 source_credential 的 ID。

awx credential_types¶

usage: awx credential_types [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx credential_types create¶

usage: awx credential_types create [-h] --name TEXT [--description TEXT]
                                   --kind {net,cloud} [--inputs JSON/YAML]
                                   [--injectors JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此凭证类型的名称。

--description <text>¶

此凭证类型的可选描述。

--kind {net,cloud}¶

--inputs <json/yaml>¶

使用 JSON 或 YAML 语法输入。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

--injectors <json/yaml>¶

使用 JSON 或 YAML 语法输入注入器。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

awx credential_types delete¶

usage: awx credential_types delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx credential_types get¶

usage: awx credential_types get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                                [--conf.color BOOLEAN] [-v]
                                id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx credential_types list¶

usage: awx credential_types list [-h] [--all] [--order_by ORDER_BY]
                                 [-f {json,yaml,jq,human}] [--filter TEXT]
                                 [--conf.color BOOLEAN] [-v]
                                 [--type {credential_type}]
                                 [--created CREATED] [--modified MODIFIED]
                                 [--name TEXT] [--description TEXT]
                                 [--kind {ssh,vault,net,scm,cloud,registry,token,insights,external,kubernetes,galaxy,cryptography}]
                                 [--namespace TEXT] [--managed BOOLEAN]
                                 [--inputs JSON/YAML] [--injectors JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {credential_type}¶

仅列出指定类型的凭据类型。

--created <created>¶

仅列出指定创建时间的凭据类型。

--modified <modified>¶

仅列出指定修改时间的凭据类型。

--name <text>¶

仅列出指定名称的凭据类型。

--description <text>¶

仅列出指定描述的凭据类型。

--kind {ssh,vault,net,scm,cloud,registry,token,insights,external,kubernetes,galaxy,cryptography}¶

仅列出指定类型的凭据类型。

--namespace <text>¶

仅列出指定命名空间的凭据类型。

--managed <boolean>¶

仅列出指定管理状态的凭据类型。

--inputs <json/yaml>¶

仅列出指定输入的凭据类型。

--injectors <json/yaml>¶

仅列出指定注入器的凭据类型。

awx credential_types modify¶

usage: awx credential_types modify [-h] [--name TEXT] [--description TEXT]
                                   [--kind {net,cloud}] [--inputs JSON/YAML]
                                   [--injectors JSON/YAML]
                                   id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此凭证类型的名称。

--description <text>¶

此凭证类型的可选描述。

--kind {net,cloud}¶

--inputs <json/yaml>¶

使用 JSON 或 YAML 语法输入。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

--injectors <json/yaml>¶

使用 JSON 或 YAML 语法输入注入器。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

awx credentials¶

usage: awx credentials [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx credentials create¶

usage: awx credentials create [-h] --name TEXT [--description TEXT]
                              [--organization ID] --credential_type ID
                              [--inputs JSON/YAML] [--user ID] [--team ID]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此凭据的名称。

--description <text>¶

此凭据的可选描述。

--organization <id>¶

从组织角色继承权限。如果在创建时提供，则不提供用户或团队。

--credential_type <id>¶

指定要创建的凭据类型。有关每种类型的详细信息，请参阅文档。

--inputs <json/yaml>¶

使用 JSON 或 YAML 语法输入。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

--user <id>¶

用于将用户添加到所有者角色的只写字段。如果提供，则不提供团队或组织。仅在创建时有效。

--team <id>¶

用于将团队添加到所有者角色的只写字段。如果提供，则不提供用户或组织。仅在创建时有效。

awx credentials delete¶

usage: awx credentials delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx credentials get¶

usage: awx credentials get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                           [--conf.color BOOLEAN] [-v]
                           id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx credentials list¶

usage: awx credentials list [-h] [--all] [--order_by ORDER_BY]
                            [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v] [--type {credential}]
                            [--created CREATED] [--modified MODIFIED]
                            [--name TEXT] [--description TEXT]
                            [--organization ID] [--credential_type ID]
                            [--managed BOOLEAN] [--inputs JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {credential}¶

仅列出指定类型的凭据

--created <created>¶

仅列出指定创建时间的凭据

--modified <modified>¶

仅列出指定修改时间的凭据

--name <text>¶

仅列出指定名称的凭据

--description <text>¶

仅列出指定描述的凭据

--organization <id>¶

仅列出指定组织的凭据

--credential_type <id>¶

仅列出指定凭据类型的凭据

--managed <boolean>¶

仅列出指定管理状态的凭据

--inputs <json/yaml>¶

仅列出指定输入的凭据

awx credentials modify¶

usage: awx credentials modify [-h] [--name TEXT] [--description TEXT]
                              [--organization ID] [--credential_type ID]
                              [--inputs JSON/YAML] [--user ID] [--team ID]
                              id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此凭据的名称。

--description <text>¶

此凭据的可选描述。

--organization <id>¶

从组织角色继承权限。如果在创建时提供，则不提供用户或团队。

--credential_type <id>¶

指定要创建的凭据类型。有关每种类型的详细信息，请参阅文档。

--inputs <json/yaml>¶

使用 JSON 或 YAML 语法输入。请参考文档了解示例语法。您可以选择指定文件路径，例如：@path/to/file.yml

--user <id>¶

用于将用户添加到所有者角色的只写字段。如果提供，则不提供团队或组织。仅在创建时有效。

--team <id>¶

用于将团队添加到所有者角色的只写字段。如果提供，则不提供用户或组织。仅在创建时有效。

awx execution_environments¶

usage: awx execution_environments [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx execution_environments create¶

usage: awx execution_environments create [-h] --name TEXT [--description TEXT]
                                         [--organization ID] --image TEXT
                                         [--credential ID]
                                         [--pull {,always,missing,never}]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此执行环境的名称。

--description <text>¶

此执行环境的可选描述。

--organization <id>¶

用于确定对该执行环境访问权限的组织。

--image <text>¶

完整的镜像位置，包括容器注册表、镜像名称和版本标签。

--credential <id>¶

关联的凭据的 ID

--pull {,always,missing,never}¶

在运行之前拉取镜像？

awx execution_environments delete¶

usage: awx execution_environments delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx execution_environments get¶

usage: awx execution_environments get [-h] [-f {json,yaml,jq,human}]
                                      [--filter TEXT] [--conf.color BOOLEAN]
                                      [-v]
                                      id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx execution_environments list¶

usage: awx execution_environments list [-h] [--all] [--order_by ORDER_BY]
                                       [-f {json,yaml,jq,human}]
                                       [--filter TEXT] [--conf.color BOOLEAN]
                                       [-v] [--type {execution_environment}]
                                       [--created CREATED]
                                       [--modified MODIFIED] [--name TEXT]
                                       [--description TEXT]
                                       [--organization ID] [--image TEXT]
                                       [--managed BOOLEAN] [--credential ID]
                                       [--pull {,always,missing,never}]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {execution_environment}¶

仅列出指定类型的执行环境。

--created <created>¶

仅列出指定创建时间的执行环境。

--modified <modified>¶

仅列出指定修改时间的执行环境。

--name <text>¶

仅列出指定名称的执行环境。

--description <text>¶

仅列出指定描述的执行环境。

--organization <id>¶

仅列出指定组织的执行环境。

--image <text>¶

仅列出指定镜像的执行环境。

--managed <boolean>¶

仅列出指定管理状态的执行环境。

--credential <id>¶

仅列出指定凭证的执行环境。

--pull {,always,missing,never}¶

仅列出指定拉取策略的执行环境。

awx execution_environments modify¶

usage: awx execution_environments modify [-h] [--name TEXT]
                                         [--description TEXT]
                                         [--organization ID] [--image TEXT]
                                         [--credential ID]
                                         [--pull {,always,missing,never}]
                                         id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此执行环境的名称。

--description <text>¶

此执行环境的可选描述。

--organization <id>¶

用于确定对该执行环境访问权限的组织。

--image <text>¶

完整的镜像位置，包括容器注册表、镜像名称和版本标签。

--credential <id>¶

关联的凭据的 ID

--pull {,always,missing,never}¶

在运行之前拉取镜像？

awx export¶

usage: awx export [-h]

-h, --help¶

显示此帮助消息并退出

awx groups¶

usage: awx groups [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx groups create¶

usage: awx groups create [-h] --name TEXT [--description TEXT] --inventory ID
                         [--variables JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此组的名称。

--description <text>¶

此组的可选描述。

--inventory <id>¶

关联的清单的 ID

--variables¶

组变量，以 JSON 或 YAML 格式。您可以选择指定文件路径，例如：@path/to/file.yml。

awx groups delete¶

usage: awx groups delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx groups get¶

usage: awx groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v]
                      id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx 组列表¶

usage: awx groups list [-h] [--all] [--order_by ORDER_BY]
                       [-f {json,yaml,jq,human}] [--filter TEXT]
                       [--conf.color BOOLEAN] [-v] [--type {group}]
                       [--created CREATED] [--modified MODIFIED] [--name TEXT]
                       [--description TEXT] [--inventory ID]
                       [--variables JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {group}¶

仅列出指定类型的组

--created <created>¶

仅列出指定创建时间的组

--modified <modified>¶

仅列出指定修改时间的组

--name <text>¶

仅列出指定名称的组

--description <text>¶

仅列出指定描述的组

--inventory <id>¶

仅列出指定清单的组

--variables¶

仅列出指定变量的组

awx 组修改¶

usage: awx groups modify [-h] [--name TEXT] [--description TEXT]
                         [--inventory ID] [--variables JSON/YAML]
                         id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此组的名称。

--description <text>¶

此组的可选描述。

--inventory <id>¶

关联的清单的 ID

--variables¶

组变量，以 JSON 或 YAML 格式。您可以选择指定文件路径，例如：@path/to/file.yml。

awx 主机指标汇总月度¶

usage: awx host_metric_summary_monthly [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx 主机指标汇总月度获取¶

usage: awx host_metric_summary_monthly get [-h] [-f {json,yaml,jq,human}]
                                           [--filter TEXT]
                                           [--conf.color BOOLEAN] [-v]
                                           id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx 主机指标汇总月度列表¶

usage: awx host_metric_summary_monthly list [-h] [--all] [--order_by ORDER_BY]
                                            [-f {json,yaml,jq,human}]
                                            [--filter TEXT]
                                            [--conf.color BOOLEAN] [-v]
                                            [--date DATE]
                                            [--license_consumed INTEGER]
                                            [--license_capacity INTEGER]
                                            [--hosts_added INTEGER]
                                            [--hosts_deleted INTEGER]
                                            [--indirectly_managed_hosts INTEGER]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--date <date>¶

仅列出指定日期的主机指标汇总月度

--license_consumed <integer>¶

仅列出指定已消耗许可证数量的主机指标汇总月度

--license_capacity <integer>¶

仅列出指定许可证容量的主机指标汇总月度

--hosts_added <integer>¶

仅列出指定新增主机数量的主机指标汇总月度

--hosts_deleted <integer>¶

仅列出指定删除主机数量的主机指标汇总月度

--indirectly_managed_hosts <integer>¶

仅列出指定间接管理主机数量的主机指标汇总月度

awx 主机指标¶

usage: awx host_metrics [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx host_metrics delete¶

usage: awx host_metrics delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx host_metrics get¶

usage: awx host_metrics get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                            [--conf.color BOOLEAN] [-v]
                            id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx host_metrics list¶

usage: awx host_metrics list [-h] [--all] [--order_by ORDER_BY]
                             [-f {json,yaml,jq,human}] [--filter TEXT]
                             [--conf.color BOOLEAN] [-v] [--hostname TEXT]
                             [--first_automation FIRST_AUTOMATION]
                             [--last_automation LAST_AUTOMATION]
                             [--last_deleted LAST_DELETED]
                             [--automated_counter INTEGER]
                             [--deleted_counter INTEGER] [--deleted BOOLEAN]
                             [--used_in_inventories INTEGER]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--hostname <text>¶

仅列出指定主机名的 host_metrics

--first_automation <first_automation>¶

仅列出指定 first_automation 的 host_metrics

--last_automation <last_automation>¶

仅列出指定 last_automation 的 host_metrics

--last_deleted <last_deleted>¶

仅列出指定 last_deleted 的 host_metrics

--automated_counter <integer>¶

仅列出指定 automated_counter 的 host_metrics

--deleted_counter <integer>¶

仅列出指定 deleted_counter 的 host_metrics

--deleted <boolean>¶

仅列出指定 deleted 的 host_metrics

--used_in_inventories <integer>¶

仅列出指定 used_in_inventories 的 host_metrics

awx hosts¶

usage: awx hosts [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx hosts create¶

usage: awx hosts create [-h] --name TEXT [--description TEXT] --inventory ID
                        [--enabled BOOLEAN] [--instance_id TEXT]
                        [--variables JSON/YAML]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该主机的名称。

--description <text>¶

该主机的可选描述。

--inventory <id>¶

关联的清单的 ID

--enabled <boolean>¶

该主机是否在线并可用于运行作业？

--instance_id <text>¶

远程清单源用来唯一标识主机的值

--variables¶

主机变量，以 JSON 或 YAML 格式。您可以选择指定文件路径，例如 @path/to/file.yml

awx hosts delete¶

usage: awx hosts delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx hosts get¶

usage: awx hosts get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                     [--conf.color BOOLEAN] [-v]
                     id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx 主机列表¶

usage: awx hosts list [-h] [--all] [--order_by ORDER_BY]
                      [-f {json,yaml,jq,human}] [--filter TEXT]
                      [--conf.color BOOLEAN] [-v] [--type {host}]
                      [--created CREATED] [--modified MODIFIED] [--name TEXT]
                      [--description TEXT] [--inventory ID]
                      [--enabled BOOLEAN] [--instance_id TEXT]
                      [--variables JSON/YAML] [--last_job ID]
                      [--last_job_host_summary ID]
                      [--ansible_facts_modified ANSIBLE_FACTS_MODIFIED]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {host}¶

仅列出指定类型的主机

--created <created>¶

仅列出指定创建时间的主机

--modified <modified>¶

仅列出指定修改时间的主机

--name <text>¶

仅列出指定名称的主机

--description <text>¶

仅列出指定描述的主机

--inventory <id>¶

仅列出指定清单的主机

--enabled <boolean>¶

仅列出指定启用状态的主机

--instance_id <text>¶

仅列出指定实例 ID 的主机

--variables¶

仅列出指定变量的主机

--last_job <id>¶

仅列出指定上一个作业的主机

--last_job_host_summary <id>¶

仅列出指定上一个作业主机摘要的主机

--ansible_facts_modified <ansible_facts_modified>¶

仅列出指定 Ansible Facts 修改时间的主机

awx 主机修改¶

usage: awx hosts modify [-h] [--name TEXT] [--description TEXT]
                        [--inventory ID] [--enabled BOOLEAN]
                        [--instance_id TEXT] [--variables JSON/YAML]
                        id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

该主机的名称。

--description <text>¶

该主机的可选描述。

--inventory <id>¶

关联的清单的 ID

--enabled <boolean>¶

该主机是否在线并可用于运行作业？

--instance_id <text>¶

远程清单源用来唯一标识主机的值

--variables¶

主机变量，以 JSON 或 YAML 格式。您可以选择指定文件路径，例如 @path/to/file.yml

awx 导入¶

usage: awx import [-h]

-h, --help¶

显示此帮助消息并退出

awx 实例组¶

usage: awx instance_groups [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx 实例组创建¶

usage: awx instance_groups create [-h] --name TEXT
                                  [--max_concurrent_jobs INTEGER]
                                  [--max_forks INTEGER]
                                  [--is_container_group BOOLEAN]
                                  [--credential ID]
                                  [--policy_instance_percentage INTEGER]
                                  [--policy_instance_minimum INTEGER]
                                  [--policy_instance_list JSON/YAML]
                                  [--pod_spec_override TEXT]

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此实例组的名称。

--max_concurrent_jobs <integer>¶

在组上运行的并发作业的最大数量。当设置为零时，不会强制执行最大值。

--max_forks <integer>¶

在组上同时执行的分叉的最大数量。当设置为零时，不会强制执行最大值。

--is_container_group <boolean>¶

指示此组中的实例是否已容器化。容器化的组具有指定的 Openshift 或 Kubernetes 集群。

--credential <id>¶

关联的凭据的 ID

--policy_instance_percentage <integer>¶

新实例上线时，将自动分配到此组的所有实例的最低百分比。

--policy_instance_minimum <integer>¶

新实例上线时，将自动分配到此组的静态最小实例数。

--policy_instance_list <json/yaml>¶

将分配到此组的精确匹配实例列表您可以选择指定文件路径，例如：@path/to/file.yml

--pod_spec_override <text>¶

awx 实例组删除¶

usage: awx instance_groups delete [-h] id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

awx 实例组获取¶

usage: awx instance_groups get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                               [--conf.color BOOLEAN] [-v]
                               id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx instance_groups list¶

usage: awx instance_groups list [-h] [--all] [--order_by ORDER_BY]
                                [-f {json,yaml,jq,human}] [--filter TEXT]
                                [--conf.color BOOLEAN] [-v]
                                [--type {instance_group}] [--name TEXT]
                                [--created CREATED] [--modified MODIFIED]
                                [--max_concurrent_jobs INTEGER]
                                [--max_forks INTEGER]
                                [--is_container_group BOOLEAN]
                                [--credential ID]
                                [--policy_instance_percentage INTEGER]
                                [--policy_instance_minimum INTEGER]
                                [--policy_instance_list JSON/YAML]
                                [--pod_spec_override TEXT]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <order_by>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <text>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <boolean>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--type {instance_group}¶

仅列出指定类型的实例组

--name <text>¶

仅列出指定名称的实例组

--created <created>¶

仅列出指定创建时间的实例组

--modified <modified>¶

仅列出指定修改时间的实例组

--max_concurrent_jobs <integer>¶

仅列出指定最大并发作业数的实例组

--max_forks <integer>¶

仅列出指定最大并行数的实例组

--is_container_group <boolean>¶

仅列出指定是否为容器组的实例组

--credential <id>¶

仅列出指定凭据的实例组

--policy_instance_percentage <integer>¶

仅列出指定策略实例百分比的实例组

--policy_instance_minimum <integer>¶

仅列出指定策略实例最小值的实例组

--policy_instance_list <json/yaml>¶

仅列出指定策略实例列表的实例组

--pod_spec_override <text>¶

仅列出指定 Pod 规格覆盖的实例组

awx instance_groups modify¶

usage: awx instance_groups modify [-h] [--name TEXT]
                                  [--max_concurrent_jobs INTEGER]
                                  [--max_forks INTEGER]
                                  [--is_container_group BOOLEAN]
                                  [--credential ID]
                                  [--policy_instance_percentage INTEGER]
                                  [--policy_instance_minimum INTEGER]
                                  [--policy_instance_list JSON/YAML]
                                  [--pod_spec_override TEXT]
                                  id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--name <text>¶

此实例组的名称。

--max_concurrent_jobs <integer>¶

在组上运行的并发作业的最大数量。当设置为零时，不会强制执行最大值。

--max_forks <integer>¶

在组上同时执行的分叉的最大数量。当设置为零时，不会强制执行最大值。

--is_container_group <boolean>¶

指示此组中的实例是否已容器化。容器化的组具有指定的 Openshift 或 Kubernetes 集群。

--credential <id>¶

关联的凭据的 ID

--policy_instance_percentage <integer>¶

新实例上线时，将自动分配到此组的所有实例的最低百分比。

--policy_instance_minimum <integer>¶

新实例上线时，将自动分配到此组的静态最小实例数。

--policy_instance_list <json/yaml>¶

将分配到此组的精确匹配实例列表您可以选择指定文件路径，例如：@path/to/file.yml

--pod_spec_override <text>¶

awx instances¶

usage: awx instances [-h] action ...

-h, --help¶

显示此帮助消息并退出

awx instances create¶

usage: awx instances create [-h] --hostname TEXT
                            [--capacity_adjustment CAPACITY_ADJUSTMENT]
                            [--enabled BOOLEAN] [--managed_by_policy BOOLEAN]
                            [--node_type {control,execution,hybrid,hop}]
                            [--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
                            [--listener_port INTEGER] [--peers PEERS]
                            [--peers_from_control_nodes BOOLEAN]

-h, --help¶

显示此帮助消息并退出

--hostname <text>¶

--capacity_adjustment <capacity_adjustment>¶

--enabled <boolean>¶

--managed_by_policy <boolean>¶

--node_type {control,execution,hybrid,hop}¶

此节点在网格中的作用。

--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}¶

表示此实例的当前生命周期阶段。

--listener_port <整数>¶

Receptor 监听传入连接的端口。

--peers <对等体>¶

--peers_from_control_nodes <布尔值>¶

如果为 True，控制平面集群节点应自动与其对等。

awx instances get¶

usage: awx instances get [-h] [-f {json,yaml,jq,human}] [--filter TEXT]
                         [--conf.color BOOLEAN] [-v]
                         id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <文本>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <布尔值>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

awx instances list¶

usage: awx instances list [-h] [--all] [--order_by ORDER_BY]
                          [-f {json,yaml,jq,human}] [--filter TEXT]
                          [--conf.color BOOLEAN] [-v] [--hostname TEXT]
                          [--type {instance}] [--uuid TEXT]
                          [--created CREATED] [--modified MODIFIED]
                          [--last_seen LAST_SEEN]
                          [--health_check_started HEALTH_CHECK_STARTED]
                          [--last_health_check LAST_HEALTH_CHECK]
                          [--errors TEXT]
                          [--capacity_adjustment CAPACITY_ADJUSTMENT]
                          [--version TEXT] [--capacity INTEGER] [--cpu CPU]
                          [--memory INTEGER] [--cpu_capacity INTEGER]
                          [--mem_capacity INTEGER] [--enabled BOOLEAN]
                          [--managed_by_policy BOOLEAN]
                          [--node_type {control,execution,hybrid,hop}]
                          [--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
                          [--ip_address TEXT] [--listener_port INTEGER]
                          [--peers_from_control_nodes BOOLEAN]

-h, --help¶

显示此帮助消息并退出

--all¶

在返回结果时获取 API 中所有页面内容（而不是仅获取第一页）

--order_by <排序依据>¶

按给定字段名对结果进行排序，在字段名前加上破折号 (-) 以反向排序，例如 –order_by=’-name’，可以通过逗号 (,) 分隔多个排序字段

-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}¶

指定输入和输出的格式

--filter <文本>¶

指定输出过滤器（仅在 jq 或 human 格式下有效）

--conf.color <布尔值>¶

显示彩色输出。默认为 True

-v, --verbose¶

打印调试级别日志，包括发出的请求

--hostname <文本>¶

仅列出具有指定主机名的实例。

--type {instance}¶

仅列出具有指定类型的实例。

--uuid <文本>¶

仅列出具有指定 uuid 的实例。

--created <创建时间>¶

仅列出具有指定创建时间 的实例。

--modified <修改时间>¶

仅列出具有指定修改时间 的实例。

--last_seen <最后一次看到时间>¶

仅列出具有指定最后一次看到时间 的实例。

--health_check_started <健康检查开始时间>¶

仅列出具有指定健康检查开始时间 的实例。

--last_health_check <最后一次健康检查时间>¶

仅列出具有指定最后一次健康检查时间 的实例。

--errors <文本>¶

仅列出具有指定错误 的实例。

--capacity_adjustment <容量调整>¶

仅列出具有指定容量调整 的实例。

--version <文本>¶

仅列出具有指定版本的实例。

--capacity <整数>¶

仅列出具有指定容量的实例。

--cpu <cpu>¶

仅列出具有指定 cpu 的实例。

--memory <整数>¶

仅列出具有指定内存 的实例。

--cpu_capacity <整数>¶

仅列出具有指定 cpu_capacity 的实例。

--mem_capacity <整数>¶

仅列出具有指定 mem_capacity 的实例。

--enabled <布尔值>¶

仅列出具有指定 enabled 的实例。

--managed_by_policy <布尔值>¶

仅列出具有指定 managed_by_policy 的实例。

--node_type {control,execution,hybrid,hop}¶

仅列出具有指定 node_type 的实例。

--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}¶

仅列出具有指定 node_state 的实例。

--ip_address <文本>¶

仅列出具有指定 ip_address 的实例。

--listener_port <整数>¶

仅列出具有指定 listener_port 的实例。

--peers_from_control_nodes <布尔值>¶

仅列出具有指定 peers_from_control_nodes 的实例。

awx instances modify¶

usage: awx instances modify [-h] [--hostname TEXT]
                            [--capacity_adjustment CAPACITY_ADJUSTMENT]
                            [--enabled BOOLEAN] [--managed_by_policy BOOLEAN]
                            [--node_type {control,execution,hybrid,hop}]
                            [--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}]
                            [--listener_port INTEGER] [--peers PEERS]
                            [--peers_from_control_nodes BOOLEAN]
                            id

id¶

资源的 ID（或唯一名称）

-h, --help¶

显示此帮助消息并退出

--hostname <文本>¶

--capacity_adjustment <容量调整>¶

--enabled <布尔值>¶

--managed_by_policy <布尔值>¶

--node_type {control,execution,hybrid,hop}¶

此节点在网格中的作用。

--node_state {provisioning,provision-fail,installed,ready,unavailable,deprovisioning,deprovision-fail}¶

表示此实例的当前生命周期阶段。

--listener_port <整数>¶

Receptor 监听传入连接的端口。

--peers <peers>¶

--peers_from_control_nodes <布尔值>¶

如果为 True，控制平面集群节点应自动与其对等。

awx inventory¶

usage: awx inventory [-h] action ...

-h, --help¶

显示此帮助消息并退出