Agent Cluster Commands

uac agent-cluster

Commands related to managing Agent Clusters, including creation, deletion, and listing

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

create

Creates a new Agent Cluster

uac agent-cluster create [OPTIONS] retain_sys_ids=value

Options

-o, --output <output>

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

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

Arguments

retain_sys_ids=value: Optional argument(s)

delete

Deletes a specific Agent Cluster

uac agent-cluster delete [OPTIONS] agentclusterid=value agentclustername=value

Options

-o, --output <output>

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

Arguments

agentclusterid=value agentclustername=value: Required argument(s)

get

Gets details of anAgent Cluster.

Args:: agent_cluster_id: agentclusterid agent_cluster_name: agentclustername

uac agent-cluster get [OPTIONS] agentclusterid=value agentclustername=value

Options

-o, --output <output>

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

Arguments

agentclusterid=value agentclustername=value: Required argument(s)

get-selected-agent

Retrieves information on a specific Agent from an Agent Cluster for which a Distribution method of Any or Lowest CPU Utilization is specified

uac agent-cluster get-selected-agent [OPTIONS] agentclustername=value
                                     ignoreexecutionlimit=value

Options

-o, --output <output>

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

Arguments

agentclustername=value ignoreexecutionlimit=value: Optional argument(s)

list

Retrieves information on all Agent Clusters

uac agent-cluster list [OPTIONS]

Options

-o, --output <output>

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

Arguments

list-advanced

Retrieves Agent Cluster details using specific query parameters

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

Options

-o, --output <output>

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

Arguments

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

resolve-cluster

Resolves the Network Alias for the specified Agent Cluster

uac agent-cluster resolve-cluster [OPTIONS] agent_cluster_name=value

Options

-o, --output <output>

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

Arguments

agent_cluster_name=value: Required argument(s)

resume

Resumes the specified Agent Cluster

uac agent-cluster resume [OPTIONS] agent_cluster_name=value

Options

-o, --output <output>

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

Arguments

agent_cluster_name=value: Required argument(s)

set-task-execution-limit

Sets the task execution limit for the specified Agent Cluster

uac agent-cluster set-task-execution-limit [OPTIONS] agent_cluster_name=value
                                           limit_type=value limit_amount=value

Options

-o, --output <output>

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

Arguments

agent_cluster_name=value limit_type=value limit_amount=value: Required argument(s)

suspend

Suspends the specified Agent Cluster

uac agent-cluster suspend [OPTIONS] agent_cluster_name=value

Options

-o, --output <output>

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

Arguments

agent_cluster_name=value: Required argument(s)

update

Modifies the Agent Cluster specified by the sysId

uac agent-cluster update [OPTIONS] version=value sys_id=value
                         exclude_related=value export_release_level=value
                         export_table=value name=value description=value
                         opswise_groups=value strict_bsrvc_membership=value
                         distribution=value network_alias=value
                         network_alias_port=value resolution_status=value
                         resolution_description=value last_resolution=value
                         limit_type=value limit_amount=value
                         current_count=value suspended=value
                         suspended_on=value resumed_on=value
                         agent_limit_type=value agent_limit_amount=value
                         last_agent_used=value ignore_inactive_agents=value
                         ignore_suspended_agents=value retain_sys_ids=value
                         agents=value notifications=value type=value

Options

-o, --output <output>

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

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

Arguments

version=value sys_id=value exclude_related=value export_release_level=value export_table=value name=value description=value opswise_groups=value strict_bsrvc_membership=value distribution=value network_alias=value network_alias_port=value resolution_status=value resolution_description=value last_resolution=value limit_type=value limit_amount=value current_count=value suspended=value suspended_on=value resumed_on=value agent_limit_type=value agent_limit_amount=value last_agent_used=value ignore_inactive_agents=value ignore_suspended_agents=value retain_sys_ids=value agents=value notifications=value type=value: Optional argument(s)