Agent Commands

uac agent

Commands for managing Agents, such as retrieving, updating, and deleting agents

uac agent [OPTIONS] COMMAND [ARGS]...

delete

Deletes an Agent

uac agent delete [OPTIONS] agentid=value agentname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agentid=value agentname=value: Required argument(s)

get

Gets details of an agent.

uac agent get [OPTIONS] agentid=value agentname=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agentid=value agentname=value: Required argument(s)

list

Retrieves information on all Agents

uac agent list [OPTIONS]

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

list-advanced

Retrieves Agent details using specific query parameters

uac agent list-advanced [OPTIONS] agentname=value type=value
                        business_services=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agentname=value type=value business_services=value: Optional argument(s)

resume

Resumes the specified Agent

uac agent resume [OPTIONS] agent_name=value agent_i_d=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agent_name=value agent_i_d=value: Required argument(s)

resume-membership

Resumes the specified Agent Cluster membership

uac agent resume-membership [OPTIONS] agent_name=value
                            agent_cluster_name=value agent_i_d=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agent_name=value agent_cluster_name=value agent_i_d=value: Required argument(s)

set-task-execution-limit

Sets the task execution limit for the specified Agent

uac agent set-task-execution-limit [OPTIONS] agent_name=value agent_i_d=value
                                   limit_type=value limit_amount=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agent_name=value agent_i_d=value limit_type=value limit_amount=value: Required argument(s)

suspend

Suspends the specified Agent

uac agent suspend [OPTIONS] agent_name=value agent_i_d=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agent_name=value agent_i_d=value: Required argument(s)

suspend-membership

Suspends the specified Agent Cluster membership

uac agent suspend-membership [OPTIONS] agent_name=value
                             agent_cluster_name=value agent_i_d=value

Options

-o, --output <output>

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

agent_name=value agent_cluster_name=value agent_i_d=value: Required argument(s)

update

Modifies the Agent specified by the sysId

uac agent update [OPTIONS] name=value description=value host_name=value
                 queue_name=value ip_address=value log_level=value
                 version=value build=value build_date=value
                 ext_api_level_min=value ext_api_level_max=value
                 extensions=value ext_accept=value ext_accept_list=value
                 hb_intvl=value hb_grace_period=value cpu_load=value os=value
                 os_release=value cpu=value hb_date=value start_date=value
                 status=value jobs=value credentials=value pid=value
                 limit_type=value limit_amount=value current_count=value
                 suspended=value decommissioned=value
                 decommissioned_date=value output_prohibited=value
                 oms_server=value sys_id=value auth_version=value
                 opswise_groups=value exclude_related=value
                 credentials_required=value notifications=value
                 transient=value type=value

Options

-o, --output <output>

-i, --input <input>: Required

-s, --select <select>: select which field to be returned. JSONPATH

Arguments

name=value description=value host_name=value queue_name=value ip_address=value log_level=value version=value build=value build_date=value ext_api_level_min=value ext_api_level_max=value extensions=value ext_accept=value ext_accept_list=value hb_intvl=value hb_grace_period=value cpu_load=value os=value os_release=value cpu=value hb_date=value start_date=value status=value jobs=value credentials=value pid=value limit_type=value limit_amount=value current_count=value suspended=value decommissioned=value decommissioned_date=value output_prohibited=value oms_server=value sys_id=value auth_version=value opswise_groups=value exclude_related=value credentials_required=value notifications=value transient=value type=value: Optional argument(s)