core.ping_remote
================

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

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>CorePingRemoteArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_type">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_type">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_type')" type="button"><span class="property-name">type</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_type" id="Call_parameters_items_i0_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "ICMP"</span><br/>
    <span class="description"><p>Ping protocol type to use.</p>
    <ul>
    <li><code>ICMP</code>: Auto-detect IPv4 or IPv6 based on hostname</li>
    <li><code>ICMPV4</code>: Force IPv4 ping</li>
    <li><code>ICMPV6</code>: Force IPv6 ping</li>
    </ul>
    </span><div class="enum-value" id="Call_parameters_items_i0_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"ICMP"</li><li class="list-group-item enum-item">"ICMPV4"</li><li class="list-group-item enum-item">"ICMPV6"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_hostname">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_hostname">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_hostname" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_hostname" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_hostname')" type="button"><span class="property-name">hostname</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_hostname" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_hostname" id="Call_parameters_items_i0_hostname">
    <div class="card-body pl-5">
    <h4>Hostname</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Target hostname or IP address to ping.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_timeout">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_timeout">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_timeout')" type="button"><span class="property-name">timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_timeout" id="Call_parameters_items_i0_timeout">
    <div class="card-body pl-5">
    <h4>Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 4</span><br/>
    <span class="description"><p>Timeout in seconds for each ping attempt.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_timeout_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>60</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_count">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_count">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_count')" type="button"><span class="property-name">count</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_count" id="Call_parameters_items_i0_count">
    <div class="card-body pl-5">
    <h4>Count</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Number of ping packets to send or <code>null</code> for default.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_count_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_count_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_count_anyOf_i0" id="Call_parameters_items_i0_count_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_count_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_count_anyOf_i1" id="Call_parameters_items_i0_count_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_count_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_count_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_count_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_interface">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_interface">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_interface" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_interface" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_interface')" type="button"><span class="property-name">interface</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_interface" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_interface" id="Call_parameters_items_i0_interface">
    <div class="card-body pl-5">
    <h4>Interface</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Network interface to use for pinging or <code>null</code> for default.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_interface_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_interface_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interface_anyOf_i0" id="Call_parameters_items_i0_interface_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_interface_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interface_anyOf_i1" id="Call_parameters_items_i0_interface_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_interface_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_interface_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_interface_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_interval">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_interval">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_interval" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_interval" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_interval')" type="button"><span class="property-name">interval</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_interval" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_interval" id="Call_parameters_items_i0_interval">
    <div class="card-body pl-5">
    <h4>Interval</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Interval between ping packets or <code>null</code> for default.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_interval_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_interval_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interval_anyOf_i0" id="Call_parameters_items_i0_interval_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_interval_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_interval_anyOf_i1" id="Call_parameters_items_i0_interval_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_interval_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_interval_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_interval_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Returns <code>true</code> if the remote host responded to ping, <code>false</code> otherwise.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* FULL_ADMIN