# core.ping_remote

Method that will send an ICMP echo request to “hostname” and will wait up to “timeout” for a reply.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: options

#### options

Type: object

CorePingRemoteArgs parameters.

No Additional Properties

##

#### Type

Type: enum (of string) Default: "ICMP"

Ping protocol type to use.

- `ICMP`: Auto-detect IPv4 or IPv6 based on hostname
- `ICMPV4`: Force IPv4 ping
- `ICMPV6`: Force IPv6 ping

##### Must be one of:

- "ICMP"
- "ICMPV4"
- "ICMPV6"

##

#### Hostname

Type: string

Target hostname or IP address to ping.

##

#### Timeout

Type: integer Default: 4

Timeout in seconds for each ping attempt.

Value must be greater or equal to `1` and lesser or equal to `60`

##

#### Count

Default: null

Number of ping packets to send or `null` for default.

## Any of

Type: integer
Type: null

##

#### Interface

Default: null

Network interface to use for pinging or `null` for default.

## Any of

Type: string
Type: null

##

#### Interval

Default: null

Interval between ping packets or `null` for default.

## Any of

Type: string
Type: null

##

#### Result

Type: boolean

Returns `true` if the remote host responded to ping, `false` otherwise.

Required roles: FULL_ADMIN