This allows you to modify a WAgent configuration.
Argument |
Required |
Description |
guid |
Yes |
This can be found by running the agent_config_query. |
name |
yes |
This is the configuration name. |
maxsession |
yes |
This is the number of max sessions. To allow users to log in concurrently to multiple workstations, set the Maximum Login Settings to a number greater than one. (Up to 10 concurrent sessions are possible.) |
ttl |
no |
ttl (Time to Live) is based on a date in the format: yyyymmdd. |
utype |
yes |
This is the User Name Type: win =Windows User Name) or env = Environmental Variable: Netsweeper_User |
gtype |
yes |
This defines the group to assign agent client: env=Use Environmental Variable: Netsweeper_GROUP, grp=Use the given group, or usr=Use group lookup by client name |
envcreate |
no |
This is environment variable: 0 or 1 |
groupname |
yes |
The name of the group to assign agent client when gtype is grp. |
defaultconf |
yes |
This is the default configuration (0 or 1) |
defaultgrp |
yes |
This is the default group to assign the agent client. |
appendu |
no |
This is string to append to the user name. Enter the domain name for the user. |
appendg |
no |
This is string to append to the group name. Enter the domain name for the group. |
comments |
no |
These are comments. |
ttlcheck |
no |
This is the type of TTL Check used for Other Clients. all - Set, Expired, UnSet set - TTL Set or Expired expired - TTL Expired |
client_ip_source |
no |
The Client IP Source to use: whatismyfilteredip_reported_ip whatismyfilteredip_peer_ip agentauthorization_peer_ip webadmin_remote_ip |
client_cleanup_expired |
Boolean |
This will cleanup expired IPs. A Boolean value 0 or 1 will set the flag to on or off. (anything other than empty and 0 will be considered as on). |
validnetworks |
no |
This limits the IP ranges a WAgent call can be made from. IP Ranges or IPs comma separated like 192.168.1.0-192.168.1.255,10.1.2.3/32,192.168.4.0/24 |
excludenetworks |
no |
Enter the network address to exclude. This allows you to exclude Network addresses from the WAgent which will override the allowed networks. IP Ranges or IPs comma separated like 192.168.1.0-192.168.1.255,10.1.2.3/32,192.168.4.0/24 |
client_os |
no |
This limits the WAgent configuration to only allow ChromeOS or a specific operating system. The following are valid mac - MacOS win - Windows android - Android cros - Chrome OS linux - Linux openbsd - OpenBSD unknown - Unknown (not in the above) |
format |
no |
The format of the output for the API: text, json or xml. The default is text. |
callback |
no |
This only works with Direct APIs. This is a JavaScript function that should be called after the API is completed. This function will be called with the response of the API. Please note: It can only be used when requesting this API via AJAX request. |
Example
servername/webadmin/api/agent_config_modify.php?guid=VALUE&name=VALUE&
maxsession=VALUE&utype=VALUE>ype=VALUE&groupname=VALUE&
defaultconf=VALUE&defaultgrp=VALUE
Output
OK: Agent Configuration created
Version: 6.2.4