Skip to main content
All tools accept device/group hostnames or names in addition to UUIDs — no UUID hunting required.

Device Tools

list_devices
tool
List all devices for your tenant.
get_device
tool
Get details for a single device by hostname or UUID.
list_device_backups
tool
List configuration backups for a device.
run_script
tool
Run a shell script or command on a device via SSH. Returns stdout and stderr.
push_file
tool
Upload a local file to a device.
pull_file
tool
Download a file from a device to a local directory.
icontrol_request
tool
Make an authenticated iControl REST API request to a device via the managed session proxy. Supports GET, POST, PUT, PATCH, DELETE.

Device Group Tools

list_device_groups
tool
List all device groups for your tenant.
get_device_group
tool
Get details for a single device group by name or UUID.
list_devices_in_group
tool
List member devices of a device group.
run_script_on_group
tool
Run a script on a device group’s active (or standby) device.
push_file_to_group
tool
Upload a local file to every device in a device group.
pull_files_from_group
tool
Download a file from every device in a group. Files are saved as <hostname>_<filename>.

Context Tools

get_context
tool
Get the active tenant context currently in use.

Tool Reference Table