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

回到目錄