object_list A list of objects to test. Accepts a search query that identifies cloud objects. The search query can be a list of object
names or IDs separated by semicolons (;), or a full search. (Required)
from_host The source host where connections are being tested. Accepts a host name, ID, or search that returns a host. The default is
gather_statistics Specify 1 to gather extra statistics, or 0 to only check the connection. The default is 0.
This task can be used to help debug connection problems in a cloud. When pinging a host, a test connection is attempted to
a running cloud server on that host. When pinging a cloud server, a test connection is attempted to that specific cloud server.
When pinging a database, a test connection is attempted to the primary database. When pinging a database copy, a test
connection is attempted to that specific database copy.
Due to the behavior of the ping task, the task succeeds if the ping succeeds, and fails if the ping fails. No specific error
is returned if the ping fails.
gather_statistics The gather_statistics parameter only applies to databases and database copies. The statistics are stored in an ETD file for
the ping agent action in the logs directory of the host specified in the from_host parameter, or the host the task ran on (if no host was specified for the
from_host If you do not set from_host, the task chooses a host in the cloud to run the ping agent action on, other than the host running the cloud server or database copy being pinged. If you are attempting to ping a tenant database, the
ping agent action runs on a host other than the host running the primary database copy.