keychaincredential.remote_ssh_host_key_scan
===========================================

Discover a remote host key (useful for `SSH_CREDENTIALS`)

.. examples(websocket)::

    :::javascript
    {
        "id": "6841f242-840a-11e6-a437-00e04d680384",
        "msg": "method",
        "method": "keychaincredential.delete",
        "params": [{
            "host": "work.freenas.org"
        }]
    }

.. 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: keychain_remote_ssh_host_key_scan</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>keychain_remote_ssh_host_key_scan</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>KeychainCredentialRemoteSshHostKeyScanArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_host">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_host">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_host" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_host')" type="button"><span class="property-name">host</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_host" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_host" id="Call_parameters_items_i0_host">
    <div class="card-body pl-5">
    <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Hostname or IP address of the remote SSH server to scan.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_host_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_port">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_port">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_port" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_port')" type="button"><span class="property-name">port</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_port" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_port" id="Call_parameters_items_i0_port">
    <div class="card-body pl-5">
    <h4>Port</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 22</span><br/>
    <span class="description"><p>TCP port number for the SSH connection.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_connect_timeout">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_connect_timeout">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_connect_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_connect_timeout" id="Call_parameters_items_i0_connect_timeout">
    <div class="card-body pl-5">
    <h4>Connect Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 10</span><br/>
    <span class="description"><p>Connection timeout in seconds.</p>
    </span>
    </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: string</span><br/>
    <span class="description"><p>SSH host public key retrieved from the remote server.</p>
    </span>
    <p><span class="badge badge-light restriction max-length-restriction" id="Return_value_maxLength">Must be at most <code>2147483647</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* KEYCHAIN_CREDENTIAL_WRITE

