keychaincredential.remote_ssh_semiautomatic_setup
=================================================

Perform semi-automatic SSH connection setup with other TrueNAS machine.

It creates an `SSH_CREDENTIALS` credential with specified `name` that can be used to connect to TrueNAS machine with specified `url` and temporary auth `token`. Other TrueNAS machine adds `private_key` to allowed `username`'s private keys. Other `SSH_CREDENTIALS` attributes such as `connect_timeout` can be specified as well.

.. examples(websocket)::

    :::javascript {
        "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "keychaincredential.remote_ssh_semiautomatic_setup", "params": [{ "name": "Work SSH connection", "url": "https://work.freenas.org", "token": "8c8d5fd1-f749-4429-b379-9c186db4f834", "private_key": 12 }] }

.. 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: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Configuration data for semi-automatic SSH credential setup.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_name" id="Call_parameters_items_i0_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name for the SSH connection credential.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_url">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_url">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_url" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_url" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_url')" type="button"><span class="property-name">url</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_url" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_url" id="Call_parameters_items_i0_url">
    <div class="card-body pl-5">
    <h4>Url</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: uri</span><br/>
    <span class="description"><p>URL of the remote TrueNAS system for semi-automatic setup.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_url_minLength">Must be at least <code>1</code> characters long</span></p><p><span class="badge badge-light restriction max-length-restriction" id="Call_parameters_items_i0_url_maxLength">Must be at most <code>2083</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_verify_ssl">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_verify_ssl">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_verify_ssl" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_verify_ssl" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_verify_ssl')" type="button"><span class="property-name">verify_ssl</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_verify_ssl" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_verify_ssl" id="Call_parameters_items_i0_verify_ssl">
    <div class="card-body pl-5">
    <h4>Verify Ssl</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether to verify SSL certificates when connecting to the remote system.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_token">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_token">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_token" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_token" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_token')" type="button"><span class="property-name">token</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_token" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_token" id="Call_parameters_items_i0_token">
    <div class="card-body pl-5">
    <h4>Token</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>API token for authentication with the remote system or <code>null</code>.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_token_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_token_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_token_anyOf_i0" id="Call_parameters_items_i0_token_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_token_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_token_anyOf_i1" id="Call_parameters_items_i0_token_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_token_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_token_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_token_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_admin_username">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_admin_username">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_admin_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_admin_username" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_admin_username')" type="button"><span class="property-name">admin_username</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_admin_username" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_admin_username" id="Call_parameters_items_i0_admin_username">
    <div class="card-body pl-5">
    <h4>Admin Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/>
    <span class="description"><p>Administrative username for the remote system.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_password">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_password">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_password" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_password')" type="button"><span class="property-name">password</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_password" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_password" id="Call_parameters_items_i0_password">
    <div class="card-body pl-5">
    <h4>Password</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Password for the administrative user or <code>null</code>.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_password_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_password_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_password_anyOf_i0" id="Call_parameters_items_i0_password_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_password_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_password_anyOf_i1" id="Call_parameters_items_i0_password_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_password_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_password_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_password_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_otp_token">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_otp_token">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_otp_token" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_otp_token" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_otp_token')" type="button"><span class="property-name">otp_token</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_otp_token" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_otp_token" id="Call_parameters_items_i0_otp_token">
    <div class="card-body pl-5">
    <h4>Otp Token</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>One-time password token for 2FA authentication or <code>null</code>.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_otp_token_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_otp_token_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_otp_token_anyOf_i0" id="Call_parameters_items_i0_otp_token_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_otp_token_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_otp_token_anyOf_i1" id="Call_parameters_items_i0_otp_token_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_otp_token_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_otp_token_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_otp_token_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_username">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_username">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_username" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_username')" type="button"><span class="property-name">username</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_username" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_username" id="Call_parameters_items_i0_username">
    <div class="card-body pl-5">
    <h4>Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/>
    <span class="description"><p>Username for the SSH connection.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_private_key">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_private_key">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_private_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_private_key')" type="button"><span class="property-name">private_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_private_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_private_key" id="Call_parameters_items_i0_private_key">
    <div class="card-body pl-5">
    <h4>Private Key</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the existing private key credential to use for SSH authentication.</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>SSH connection timeout in seconds.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_sudo">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_sudo">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_sudo" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_sudo" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_sudo')" type="button"><span class="property-name">sudo</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_sudo" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_sudo" id="Call_parameters_items_i0_sudo">
    <div class="card-body pl-5">
    <h4>Sudo</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Whether the SSH user should use sudo for elevated privileges.</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>SSHCredentialsEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The created SSH credential configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Unique identifier for this keychain credential.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_name" data-toggle="collapse" onclick="setAnchor('#Return_value_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_name" id="Return_value_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Distinguishes this Keychain Credential from others.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_type" data-toggle="collapse" onclick="setAnchor('#Return_value_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_type" id="Return_value_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="description"><p>Keychain credential type identifier for SSH connection credentials.</p>
    </span><span class="const-value" id="Return_value_type_const">Specific value: <code>"SSH_CREDENTIALS"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes" id="Return_value_attributes">
    <div class="card-body pl-5">
    <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>SSH connection attributes including host, authentication, and connection settings.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_attributes_host">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_host">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_host" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_host')" type="button"><span class="property-name">host</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_host" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_host" id="Return_value_attributes_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>SSH server hostname or IP address.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes_port">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_port">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_port" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_port')" type="button"><span class="property-name">port</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_port" id="Return_value_attributes_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>SSH server port number.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes_username">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_username">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_username" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_username')" type="button"><span class="property-name">username</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_username" id="Return_value_attributes_username">
    <div class="card-body pl-5">
    <h4>Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/>
    <span class="description"><p>SSH username for authentication.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes_private_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_private_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_private_key')" type="button"><span class="property-name">private_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_private_key" id="Return_value_attributes_private_key">
    <div class="card-body pl-5">
    <h4>Private Key</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Keychain Credential ID.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes_remote_host_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_remote_host_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_remote_host_key" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_remote_host_key')" type="button"><span class="property-name">remote_host_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_remote_host_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_remote_host_key" id="Return_value_attributes_remote_host_key">
    <div class="card-body pl-5">
    <h4>Remote Host Key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Can be discovered with keychaincredential.remote<em>ssh</em>host<em>key</em>scan.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_attributes_connect_timeout">
    <div class="card">
    <div class="card-header" id="headingReturn_value_attributes_connect_timeout">
    <h2 class="mb-0">
    <button aria-controls="Return_value_attributes_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_attributes_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Return_value_attributes_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_attributes_connect_timeout" class="collapse property-definition-div" data-parent="#accordionReturn_value_attributes_connect_timeout" id="Return_value_attributes_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 for SSH connections.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* KEYCHAIN_CREDENTIAL_WRITE

