Enable or disable a protection feature.
Usage: cytoolprotect \ \
where:
\—Changes protection for an agent feature. Options are: enable, disable, policy, and query. The query option displays the protection status for each feature.\—Specifies the feature for which you want to change the protection status. Options are process for agent core processes, registry for agent registry keys, file for agent files, service for agent services.
and pipe for protection of agent pipes
For example:
C:\Program Files\Palo Alto Networks\Traps>cytoolprotect disable processProtection Mode StateProcess Disabled DisabledRegistry Policy EnabledFile Policy EnabledService Policy EnabledPipe Policy Enabled
Enable, disable, or query the startup state of the Cortex XDR agent components.
Usage: cytool startup \ \
where:
\—Changes startup action for an agent component. Options are: enable, disable, and query. The query option displays the startup status for each component.\—Specifies the component for which you want to change the startup action. To change the startup action for multiple components, list them with spaces separating each component. Options are: cyverak, cyvrmtgn, cyvrfsfd, cyserver , and telam.For example:
C:\Program Files\Palo Alto Networks\Traps>cytool startup disable cyverak cyvrfsfd Enter supervisor password: Service Startup cyverak Disabled cyvrmtgn System cyvrfsfd Disabled cyserver Automatic telam Automatic
Stop or start product components.
Usage: cytool runtime \ \ \
where:
\—Changes startup runtime action for an agent component. Options are: start, stop, and query. The query option displays the startup status for each component.\—Specifies the component for which you want to change the runtime action, or you can specify all components by not including any in this command. To change the runtime action for a subset of components, list them with spaces separating each component. Options are: cyverak, cyvrmtgn, cyvrfsfd, and cyserver. .\—Specifies the seconds to wait for each component to start/stop. The default is forever. time.For example:
C:\Program Files\Palo Alto Networks\Traps> cytool runtime stop cyserver cyverakEnter supervisor password: Service State cyverak Stopped cyvrmtgn Running cyvrfsfd Running cyserver Stopped
Operate product trace sessions.
Usage:
cytool trace start \—Starts the trace session and logs the results to a file with a maximum \ in MB (up to 25MB).cytool trace stop—Stops the trace session.cytool trace reset—Resets all tracing configurations to their default values. If an active logging session exists, Cytool will restart the session.cytool trace set \ \ \, where:
\ can be either all (set the log level for all components) or one of the following individual components: cyvrlpc, cyvrfsfd, cyverak, cyvrmtgn, cyreport, cyserver, cyapi, cylnk, cyrprtui, cytray, tlacore, cytool, cyverau, cyinjct, cyvrtrap, cyvera, ntnativeapi, winutils, or panwd.\ can be one of the following log levels: NONE, CRITICAL, ERROR, WARNING, INFO, VERBOSE, DEBUG, or ALL.\ is the mask (hex) of one or more trace flags (a maximum of 31) separated by spaces that the agent assigns to each trace when a program runs on the endpoint (for example 0x7FFFFFFF, or 0x5). The trace flag is a property of a trace provider (in this case, Cortex XDR) and determines which events the agent generates. You can use the trace flag to filter events that the agent traces.cytool trace convert \—Extract the encoded event trace log (ETL) file using a trace message format (TMF) file as a key to a file with the same name and store the result in %ProgramData%\Cyvera\Logs\Log.txt. When a TMF file is not supplied, Cytool uses the default TMF file stored in the %ProgramData\Cyvera\Logs\ folder to convert the ETL file.
Note
This command is not supported on Windows XP SP3.
View, restore and delete quarantined files.
Usage:
cytool quarantine list—List all quarantined files.cytool quarantine restore \ \[\] —Restore files to their original location or to a path, if specified, by specifying the file ID.cytool quarantine delete \—Delete the quarantined file specified by the quarantine ID.Query Cortex XDR agent statistics from a running process.
Usage: cytoolstat \
where \ is the process ID (PID).
For example, to display statistics about the Chrome process identified by PID 4080:
c:\Program Files\Palo Alto Networks\Traps> cytool stat 4080 DllSec Invocations: 0 DllSec Time: 00:00:00.0 G01 Invocations: 0 G01 Time: 00:00:00.0 G01 Thunk 00 Resolution: 0 G01 Thunk 01 Resolution: 0 G01 Thunk 02 Resolution: 0 G01 Thunk 03 Resolution: 0 G01 Thunk 04 Resolution: 0 G01 Thunk 05 Resolution: 0 G01 Thunk 06 Resolution: 0 G01 Thunk 07 Resolution: 0 G01 Thunk 08 Resolution: 0 G01 Thunk 09 Resolution: 0 G01 Thunk 10 Resolution: 0 G01 Thunk 11 Resolution: 0 G01 Thunk 12 Resolution: 0 G01 Thunk 13 Resolution: 0 G01 Thunk 14 Resolution: 0 G01 Thunk 15 Resolution: 0 G01 Stack Walk Resolution: 0 J01 Minimum Stack Depth: 166 J01Checks: 25 J01 Stack Walk Checks: 0
Display general Cortex XDR agent information.
Usage: cytool info \[query]
To display the agent version, run the cytool info command without any additional arguments. To display additional details about the agent, such as the version of the default policy and the specific build number, add the query argument. For example:
C:\Program Files\Palo Alto Networks\Traps>cytool info Cortex XDR (R) supervisor tool 7.0.0.27797 (c) Palo Alto Networks, Inc. All rights reserved General Cortex XDR information. USAGE: cytool info query C:\Program Files\Palo Alto Networks\Traps>cytool info query Content Type: 113 Content Build: 18279 Content Version: 113-18297 Event Log: 1
Prepare a golden image by submitting files for cloud analysis and generate a threats report.
Usage: cytool imageprep \[scan] \[timeout \]\[upload \] \[path \]
where:
\—The number of hours the scan is permitted to run before reporting an error.\—The number of minutes the agent can take to upload unknown files to Cortex XDR before reporting an error.\—Path to store the scan report. If no path is specified, Cytool saves the scan report to the local Cytool directory. To save files to this folder, you must disable service protection using the cytool protect disable command.For example:
C:\Program Files\Palo Alto Networks\Traps>cytool imageprep scan timeout 4 upload 60 path c:\report Start Time : 17:56:46 Elapsed Time : 00:04:17 State : Running Scanned Files : 5427 Suspicious Files : 0 Failed Files : 9 Volume Root Path : \\?\C:\ Window Usage : 0 236 20000 Path : ...t\cache2\entries\9B982CE198BF046E6CCF25478920DDFD9E5842E5 Scan completed successfully Complete report can be found at: C:\report\imageprep\_2019-03-06\_08-59-30.xml
Scan operations.
Usage: cytool scan \
where \:
start—Scans the endpoint for malware.stop—Stops a scan.query—Displays the progress if a system scan is active.For example:
C:\Program Files\Palo Alto Networks\Traps>cytool scan start Enter supervisor password: The operation completed successfully. C:\Program Files\Palo Alto Networks\Traps>cytool scan query Enter supervisor password: Start Time : 9:09:0648 Elapsed Time : 00:00:51 State : Running Scanned Files : 3944 Suspicious Files : 0 Failed Files : 1?\C:\ Volume Root Path : \\?\C:\ 8 20000 Window Usage : 0 14 20000 Path : ...m.BubbleWitch3Saga\_6.1.0\_x86\_\_kgqvnymyfvs32\res\_output\particles\collected\_counter\_feathers.xml The operation completed successfully. C:\Program Files\Palo Alto Networks\Traps>cytool scan stopEnter supervisor password: The operation completed successfully.
The Cortex XDR agent stores policy and security event information, such as the list of trusted signers, local verdicts, and one-time actions in local databases on the endpoint. To troubleshoot policy issues and security events, you can use cytool persist operations to import, export, and view information stored in the local database.
Usage: cytool persist \
where \:
list—Lists the local databases on the endpoint.export \[\\`Set log level for the desired process.
Usage: cytool log set\_level \
where:
\—An integer value corresponding to the log level:
\ can be all or it can be one or more of the following agent components: trapsd, authorized, pmd, or cortex xdr.Then use the cytool log collect command to generate a support file archive of all logs in a TGZ file.
Initiate check-in to the server.
Usage: cytool checkin
To verify the checkin, view the check-in time on the agent console.
| | **`last_checkin`** | — |Display the time of the last successful check-in.
Usage: cytool last\_checkin
For example:
C:\Program Files\Palo Alto Networks\Traps>cytool last\_checkin Persistent Last Check-In time Database agent\_settings: persistence::DB: C:\ProgramData\Cyvera\LocalSystem\Persistence\agent\_settings.db: Open persistence::DB: C:\ProgramData\Cyvera\LocalSystem\Persistence\agent\_settings.db: Open: IO error: C:\ProgramData\Cyvera\LocalSystem\Persistence\agent\_settings.db\LOCK: Could not lock file. Last Check-In time (UTC): 2020-01-27T09:53:50Z Last Check-In time (local): 2020-01-27T11:53:50Z Total: 1 records persistence::DB: C:\ProgramData\Cyvera\LocalSystem\Persistence\agent\_settings.db: Close
Run EDR operations.
Usage:
cytool edr \
where \ can be:
dump—Dumps EDR events.stats—Displays EDR stats collected on the endpoint.Stop or query payload execution status. Relates to Live Terminal and script execution.
Usage:
cytool payload\_execution query—Display current payload execution status.
For example:
cytool payload\_execution stop—Stops payload execution.Display current websocket connection status.
Usage: cytool websocket query
For example:
C:\Program Files\Palo Alto Networks\Traps>cytool websocket queryCurrent status of websocket connection is: server: wss\://ch-panw-61-beta.traps.paloaltonetworks.com/operations/socket connected: true enabled: true uptime: 00:39:46.444
Try reconnecting to the server if communication has been disabled, or force registration with a new distribution\_id.
Usage:
cytool reconnect—Reconnects the Cortex XDR agent to the management application on the server, either Traps management service or Cortex XDR.Update hostname of Golden image and ID in the peristent database.
Usage: cytool vdi update
Update is the only operation available at this point.
| | **`proxy`** |  |Set or query cloud-defined proxies for the agent.
Usage:
cytool proxy query—Displays the current status of cloud-defined proxy settings.cytool proxy set \
—Set cloud-defined proxy settings to the proxies defined in \
. For example: cytool proxy set "192.168.50.1:8080,192.168.60.2:808"cytool proxy set “”—Disable cloud-defined proxy.Start or stop event collection (EDR/DSE).
Usage: cytool event\_collection \
cytool event\_collection query—Display current event collection status.cytool event\_collection enable—Start or stop event collection as set by policy.cytool event\_collection disable—Forcibly stop event collection.cytool event\_collection logstat—Write internal statistics to the log file.Release endpoint from network isolation.
Usage: cytool isolate stop
Displays the current token hash of the endpoint.
Usage: cytool token query
Usage: cytool endpoint\_tags \, where \ can be:
add—Add tags to the endpoint tag list.remove—Remove the given tags from the list of endpoint tags.list—Display the available list of endpoint tags.Note
Tags should be passed as one string, separated by commas, and with no spaces.
For example:
cytool endpoint\_tags add “tag1\[,tage2,...,tagN]”Host firewall operations.
Usage: cytool firewall \
where \ can be:
enable—Activates host firewall componentdisable—Stops a scan.query—Displays the progress if a system scan is active.show—Displays the progress if a system scan is active.Imports pre-downloaded content package.
Usage: cytool import content\
(Behavioral threat protection) BTP operations.
Usage: cytool btp \
where \ can be:
verbose\_log enable—enables BTP verbose logging.verbose\_log disable—disables BTP verbose logging.watch enable \—Enables the watch command for the specified item.watch disable \—disables the watch command for the specified item.item name can be:Displays file properties for a given hash/path.
Usage: cytool file\_search \
where \ can be:
hash
—Displays file properties for a given hash.
path
—Displays file properties for a given path.
File system scan properties.
Usage:cytool file\_system\_scan \[start] \[stop] or \[query]
where start—Starts the full system scan.
stop—Stops the file system scan. query—Displays file progress of the file system scan, if it’s still active.
Import file system.
Usage:cytool import \ where: content \—Imports and applies content from the given file.
suex \
—Imports and applies local support exception. Options are:
\\\Displays the start time of the last successful system scan.
Usage:cytool misc last\_scan\_time
Peer to peer settings
Usage:cytool p2p \
where \:
status—Displays status and configuration of peer to peer.enable—Enables peer to peer.disable—Disables peer to peer.port—Changes peer to peer port to 1234.Displays blocked IPs and whilelisted IPs and option to unblock one or more IPs.
Usage: cytool unblock\_remote\_ip \
where \ can be:
list
—Displays list of blocked IPs.
wlist
—Displays list of white listed IPs.
unblock
—Unblock an IP address or all. Options are: all IP address
Adaptive policy agent commands.
Usage: cytool adaptive\_policy \ \ \ \
where:
interval —Sets a recalculation interval override (in seconds), or reset an override. Options are: seconds policycollect\_stats —Initiates a collection of internal statistics.recalc —Triggers a recalculation of the adaptive policy.query —Query the current interval and APEX.Set security profiles.
Usage: cytool security \
where: \—Options are: enable, disable, or query.The query option displays the startup status for each component.
C:\Program Files\Palo Alto Networks\Traps>cytool security disableEnter supervisor password: Security profiles are now disabled.
Prints all the cytool security events
Usage: cytool security\_events print
Set the number of HTTP requests for each of the known URLs.
Usage: cytool connectivity\_test \
where: \—is the number of HTTP requests for each of the known URLs.