Agent

# 目录

• 介绍
• 用法
• List
  • 用法
  • 示例
• get-default
  • 用法
  • 示例
• Discard
  • 用法
  • 示例

# 介绍

orxray 的很多子命令都是在某些 agent 执行的，如果你在命令行中明确的指定在哪个 agent 上来执行，则会在默认的 agent 执行。

这个默认的agent设置在 ~/.orxray/config 配置文件中。默认被设置为你的当前机器 agent 的 ID 号，你可以修改 default_agent 选项来设置默认值。

orxray agent 子命令可以获取 agent 列表，显示当前的默认 agent 信息。

回到目录

# 用法

Usage: orxray agent ACTION [OPTIONS]

ACTIONS:
    list
    autorun
    discard
    get-default

GLOBAL OPTIONS:
    --help
    --config                           Specify the config file, default is ~/.orxray/config.

回到目录

# List

这个子命令可以打印出 agent 列表

回到目录

# 用法

Usage: orxray agent list [OPTIONS]

OPTIONS:
    -s, --page-size integer            page size, 20(default).

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

-s, --page-size integer

指定显示列表的最大数量

回到目录

# 示例

显示 agent 列表

$ orxray agent list
ID      HOSTNAME                        IP              SYSTEM          VERSION
1       centos7                         13.17.28.191    centos-7        816
4       amzn2-xray-agent                13.17.28.193    amazon-2        816
5       suse15-aa                       13.17.29.132    opensuse-15     802
7       ubuntu18-xray-agent             13.17.28.195    ubuntu-bionic   816
9       deploy-server                   18.12.20.58     centos-7        796
10      centos7                         13.17.231.163   centos-7        797

指定列表的最大显示数量

$ orxray agent list -s 3
ID      HOSTNAME                        IP              SYSTEM          VERSION
1       centos7                         13.17.28.191    centos-7        816
4       amzn2-xray-agent                13.17.28.192    amazon-2        816
5       suse15-aa                       13.17.29.132    opensuse-15     802

回到目录

# Get-default

获取默认 Agent 的详细信息

# 用法

Usage: orxray agent get-default

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

回到目录

# 示例

$ orxray agent get-default
ID      HOSTNAME                IP              SYSTEM          VERSION
29      centos7-xxx-1           83.37.218.191   centos-7        816

回到目录

# Discard

禁用指定的 Agent。Agent 被禁用后，在 console 上的 Agent 节点就会被删除，同时会释放一个节点的 license 额度。注意，在禁用指定节点后，在相同机器上重新安装 Agent 也无法再恢复使用。

# 用法

Usage: orxray agent discard [OPTIONS]

OPTIONS:
    -a, --agent integer                Agent ID, please use agent default command to set default agent.
                                       If agent ID is not specified, the default_agent will be used.

GLOBAL OPTIONS:
    --help
    --config                           Specify the config file, default is ~/.orxray/config.

回到目录

# 示例

$ orxray agent discard 1

Agent '1' is successfully discarded

回到目录