Skip to content

Proxy Group

add_proxy_to_group

add_proxy_to_group <NAME_OR_ID> <PROXY_GROUP> <LOCAL_ADDRESS> <LOCAL_PORT>

Add a proxy to a proxy group.

Requires a local address and port for active agent redirection if if the proxy does not have it set.

Examples

Add a proxy to a proxy group

add_proxy_to_group proxy1 group1 192.168.0.2 10051

Arguments

NAME_OR_ID
Name or ID of proxy to add.
Type: text
Required:

PROXY_GROUP
Name or ID of proxy group to add proxy to.
Type: text
Required:

LOCAL_ADDRESS
Address for active agents.
Type: text

LOCAL_PORT
Address for active agents.
Type: text


remove_proxy_from_group

remove_proxy_from_group <NAME_OR_ID>

Remove a proxy from a proxy group.

Arguments

NAME_OR_ID
Name or ID of proxy to remove.
Type: text
Required:


show_proxy_group_hosts

show_proxy_group_hosts <PROXYGROUP>

Show all hosts in a proxy group.

Arguments

PROXYGROUP
Proxy group name or ID. Supports wildcards.
Type: text
Required:


show_proxy_groups

show_proxy_groups <NAME_OR_ID> [OPTIONS]

Show all proxy groups and their proxies.

Optionally takes in a list of names or IDs to filter by.

Examples

Show all proxy groups

show_proxy_groups

Show proxy groups with a specific proxy

show_proxy_groups --proxy proxy1

Show proxy groups with either proxy1 or proxy2

show_proxy_groups --proxy proxy1,proxy2

Arguments

NAME_OR_ID
Filter by proxy name or ID. Comma-separated. Supports wildcards.
Type: text

Options

--proxy <PROXIES>
Show only groups containing these proxies. Comma-separated.
Type: text


update_hostgroup_proxygroup

update_hostgroup_proxygroup <HOSTGROUP> <PROXYGROUP> [OPTIONS]

Assign a proxy group to all hosts in one or more host groups.

Arguments

HOSTGROUP
Host group(s). Comma-separated. Supports wildcards.
Type: text
Required:

PROXYGROUP
Proxy group to assign. Supports wildcards.
Type: text
Required:

Options

--dryrun/--no-dryrun
Preview changes.
Type: boolean
Default: False