rsynctask.get_instance
======================

Returns instance matching `id`. If `id` is not found, Validation error is raised.

Please see `query` method documentation for `options`.

.. 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: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    <h5>Parameter 2: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Query options customize the results returned by a query method. More complete documentation with examples     are covered in the "Query methods" section of the TrueNAS API documentation. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_extra">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_extra">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extra" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extra')" type="button"><span class="property-name">extra</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_extra" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extra" id="Call_parameters_items_i1_extra">
    <div class="card-body pl-5">
    <h4>Extra</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/>
    <span class="description"><p>Extra options are defined on a per-endpoint basis and are described in the documentation for the associated     query method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_order_by">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_order_by">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_order_by')" type="button"><span class="property-name">order_by</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_order_by" id="Call_parameters_items_i1_order_by">
    <div class="card-body pl-5">
    <h4>Order By</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names describing the manner in which query results should be ordered. The field names may     also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place     any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the     results list). </p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1_order_by_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_order_by_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"size"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"-devname"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"nulls_first:-expiretime"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_select">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_select">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_select')" type="button"><span class="property-name">select</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_select" id="Call_parameters_items_i1_select">
    <div class="card-body pl-5">
    <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code>     may be used to explicitly select only subkeys of the query result. </p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1_select_items">
    <br/>
    <div class="any-of-value" id="Call_parameters_items_i1_select_items_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_select_items_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i0" id="Call_parameters_items_i1_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_i1_select_items_anyOf_i1" id="Call_parameters_items_i1_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_i1_select_items_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_i1_select_items_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1_select_items_anyOf_i1_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div></div></div>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_select_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"username"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"Authentication.status"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_count">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_count">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_count')" type="button"><span class="property-name">count</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_count" id="Call_parameters_items_i1_count">
    <div class="card-body pl-5">
    <h4>Count</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>Return a numeric value representing the number of items that match the specified <code>query-filters</code>. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_get">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_get">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_get" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_get" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_get')" type="button"><span class="property-name">get</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_get" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_get" id="Call_parameters_items_i1_get">
    <div class="card-body pl-5">
    <h4>Get</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>Return the JSON object of the first result matching the specified <code>query-filters</code>. The query fails     if there specified <code>query-filters</code> return no results. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_offset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_offset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_offset')" type="button"><span class="property-name">offset</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_offset" id="Call_parameters_items_i1_offset">
    <div class="card-body pl-5">
    <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option     it may be used to implement pagination of large results arrays. WARNING: some query methods provide     volatile results and the onus is on the developer to understand whether pagination is appropriate     for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_limit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_limit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_limit')" type="button"><span class="property-name">limit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_limit" id="Call_parameters_items_i1_limit">
    <div class="card-body pl-5">
    <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When     combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.</p>
    <p>WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether     pagination is appropriate for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_force_sql_filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_force_sql_filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force_sql_filters" id="Call_parameters_items_i1_force_sql_filters">
    <div class="card-body pl-5">
    <h4>Force Sql Filters</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>Force use of SQL for result filtering to reduce response time. May not work for all methods.</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>RsyncTaskEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <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 the rsync task.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_path">
    <div class="card">
    <div class="card-header" id="headingReturn_value_path">
    <h2 class="mb-0">
    <button aria-controls="Return_value_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_path" data-toggle="collapse" onclick="setAnchor('#Return_value_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_path" id="Return_value_path">
    <div class="card-body pl-5">
    <h4>Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Local filesystem path to synchronize.</p>
    </span>
    <p><span class="badge badge-light restriction max-length-restriction" id="Return_value_path_maxLength">Must be at most <code>1023</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_user">
    <div class="card">
    <div class="card-header" id="headingReturn_value_user">
    <h2 class="mb-0">
    <button aria-controls="Return_value_user" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_user" data-toggle="collapse" onclick="setAnchor('#Return_value_user')" type="button"><span class="property-name">user</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_user" class="collapse property-definition-div" data-parent="#accordionReturn_value_user" id="Return_value_user">
    <div class="card-body pl-5">
    <h4>User</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Username to run the rsync task as.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mode">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mode">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mode" data-toggle="collapse" onclick="setAnchor('#Return_value_mode')" type="button"><span class="property-name">mode</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mode" class="collapse property-definition-div" data-parent="#accordionReturn_value_mode" id="Return_value_mode">
    <div class="card-body pl-5">
    <h4>Mode</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "MODULE"</span><br/>
    <span class="description"><p>Operating mechanism for Rsync, i.e. Rsync Module mode or Rsync SSH mode.</p>
    </span><div class="enum-value" id="Return_value_mode_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"MODULE"</li><li class="list-group-item enum-item">"SSH"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_remotehost">
    <div class="card">
    <div class="card-header" id="headingReturn_value_remotehost">
    <h2 class="mb-0">
    <button aria-controls="Return_value_remotehost" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remotehost" data-toggle="collapse" onclick="setAnchor('#Return_value_remotehost')" type="button"><span class="property-name">remotehost</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_remotehost" class="collapse property-definition-div" data-parent="#accordionReturn_value_remotehost" id="Return_value_remotehost">
    <div class="card-body pl-5">
    <h4>Remotehost</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>IP address or hostname of the remote system. If username differs on the remote host, "username@remote_host"     format should be used.</p>
    </span><div class="any-of-value" id="Return_value_remotehost_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_remotehost_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remotehost_anyOf_i0" id="Return_value_remotehost_anyOf_i0" onclick="setAnchor('#Return_value_remotehost_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remotehost_anyOf_i1" id="Return_value_remotehost_anyOf_i1" onclick="setAnchor('#Return_value_remotehost_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_Return_value_remotehost_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_Return_value_remotehost_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="accordionReturn_value_remoteport">
    <div class="card">
    <div class="card-header" id="headingReturn_value_remoteport">
    <h2 class="mb-0">
    <button aria-controls="Return_value_remoteport" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remoteport" data-toggle="collapse" onclick="setAnchor('#Return_value_remoteport')" type="button"><span class="property-name">remoteport</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_remoteport" class="collapse property-definition-div" data-parent="#accordionReturn_value_remoteport" id="Return_value_remoteport">
    <div class="card-body pl-5">
    <h4>Remoteport</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Port number for SSH connection. Only applies when <code>mode</code> is SSH.</p>
    </span><div class="any-of-value" id="Return_value_remoteport_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_remoteport_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remoteport_anyOf_i0" id="Return_value_remoteport_anyOf_i0" onclick="setAnchor('#Return_value_remoteport_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remoteport_anyOf_i1" id="Return_value_remoteport_anyOf_i1" onclick="setAnchor('#Return_value_remoteport_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_Return_value_remoteport_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_Return_value_remoteport_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="accordionReturn_value_remotemodule">
    <div class="card">
    <div class="card-header" id="headingReturn_value_remotemodule">
    <h2 class="mb-0">
    <button aria-controls="Return_value_remotemodule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remotemodule" data-toggle="collapse" onclick="setAnchor('#Return_value_remotemodule')" type="button"><span class="property-name">remotemodule</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_remotemodule" class="collapse property-definition-div" data-parent="#accordionReturn_value_remotemodule" id="Return_value_remotemodule">
    <div class="card-body pl-5">
    <h4>Remotemodule</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Name of remote module, this attribute should be specified when <code>mode</code> is set to MODULE.</p>
    </span><div class="any-of-value" id="Return_value_remotemodule_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_remotemodule_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remotemodule_anyOf_i0" id="Return_value_remotemodule_anyOf_i0" onclick="setAnchor('#Return_value_remotemodule_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remotemodule_anyOf_i1" id="Return_value_remotemodule_anyOf_i1" onclick="setAnchor('#Return_value_remotemodule_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_Return_value_remotemodule_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_Return_value_remotemodule_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="accordionReturn_value_ssh_credentials">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials')" type="button"><span class="property-name">ssh_credentials</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials" id="Return_value_ssh_credentials">
    <div class="card-body pl-5">
    <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>In SSH mode, if <code>ssh_credentials</code> (a keychain credential of <code>SSH_CREDENTIALS</code> type) is specified then it is     used to connect to the remote host. If it is not specified, then keys in <code>user</code>'s .ssh directory are used.</p>
    </span><div class="any-of-value" id="Return_value_ssh_credentials_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_ssh_credentials_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0" id="Return_value_ssh_credentials_anyOf_i0" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0')" role="tab">KeychainCredentialEntry</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i1" id="Return_value_ssh_credentials_anyOf_i1" onclick="setAnchor('#Return_value_ssh_credentials_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_Return_value_ssh_credentials_anyOf_i0" role="tabpanel">
    <h4>KeychainCredentialEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_ssh_credentials_anyOf_i0_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_id" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_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_ssh_credentials_anyOf_i0_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_id" id="Return_value_ssh_credentials_anyOf_i0_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_ssh_credentials_anyOf_i0_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_name" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_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="headingReturn_value_ssh_credentials_anyOf_i0_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_name" id="Return_value_ssh_credentials_anyOf_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>Distinguishes this Keychain Credential from others.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_ssh_credentials_anyOf_i0_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ssh_credentials_anyOf_i0_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_type" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_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_ssh_credentials_anyOf_i0_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_type" id="Return_value_ssh_credentials_anyOf_i0_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Type of credential stored in the keychain.</p>
    <ul>
    <li><code>SSH_KEY_PAIR</code>: SSH public/private key pair</li>
    <li><code>SSH_CREDENTIALS</code>: SSH connection credentials including host and authentication</li>
    </ul>
    </span><div class="enum-value" id="Return_value_ssh_credentials_anyOf_i0_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"SSH_KEY_PAIR"</li><li class="list-group-item enum-item">"SSH_CREDENTIALS"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_ssh_credentials_anyOf_i0_attributes">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_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_ssh_credentials_anyOf_i0_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes" id="Return_value_ssh_credentials_anyOf_i0_attributes">
    <div class="card-body pl-5">
    <h4>Attributes</h4><br/>
    <span class="description"><p>Credential-specific configuration and authentication data.</p>
    </span><div class="any-of-value" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0')" role="tab">SSHKeyPair</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1')" role="tab">SSHCredentials</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0" role="tabpanel">
    <h4>SSHKeyPair</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>At least one of the two keys must be provided on creation.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key')" type="button"><span class="property-name">private_key</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key">
    <div class="card-body pl-5">
    <h4>Private Key</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>SSH private key in OpenSSH format. <code>null</code> if only public key is provided.</p>
    </span><div class="any-of-value" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_i0" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_i0" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_i1" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_anyOf_i1" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_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_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_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_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_private_key_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="accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key')" type="button"><span class="property-name">public_key</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key">
    <div class="card-body pl-5">
    <h4>Public Key</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Can be omitted and automatically derived from the private key.</p>
    </span><div class="any-of-value" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i0" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i0" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i1" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i1" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_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_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_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_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i0_public_key_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1" role="tabpanel">
    <h4>SSHCredentials</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_host" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port')" type="button"><span class="property-name">port</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_port" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username')" type="button"><span class="property-name">username</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_username" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_private_key" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_remote_host_key" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout">
    <div class="card">
    <div class="card-header" id="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout">
    <h2 class="mb-0">
    <button aria-controls="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_connect_timeout" id="Return_value_ssh_credentials_anyOf_i0_attributes_anyOf_i1_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 class="tab-pane fade card-body" id="tab-pane_Return_value_ssh_credentials_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="accordionReturn_value_remotepath">
    <div class="card">
    <div class="card-header" id="headingReturn_value_remotepath">
    <h2 class="mb-0">
    <button aria-controls="Return_value_remotepath" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remotepath" data-toggle="collapse" onclick="setAnchor('#Return_value_remotepath')" type="button"><span class="property-name">remotepath</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_remotepath" class="collapse property-definition-div" data-parent="#accordionReturn_value_remotepath" id="Return_value_remotepath">
    <div class="card-body pl-5">
    <h4>Remotepath</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Path on the remote system to synchronize with.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_direction">
    <div class="card">
    <div class="card-header" id="headingReturn_value_direction">
    <h2 class="mb-0">
    <button aria-controls="Return_value_direction" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_direction" data-toggle="collapse" onclick="setAnchor('#Return_value_direction')" type="button"><span class="property-name">direction</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_direction" class="collapse property-definition-div" data-parent="#accordionReturn_value_direction" id="Return_value_direction">
    <div class="card-body pl-5">
    <h4>Direction</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "PUSH"</span><br/>
    <span class="description"><p>Specify if data should be PULLED or PUSHED from the remote system.</p>
    </span><div class="enum-value" id="Return_value_direction_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"PULL"</li><li class="list-group-item enum-item">"PUSH"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_desc">
    <div class="card">
    <div class="card-header" id="headingReturn_value_desc">
    <h2 class="mb-0">
    <button aria-controls="Return_value_desc" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_desc" data-toggle="collapse" onclick="setAnchor('#Return_value_desc')" type="button"><span class="property-name">desc</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_desc" class="collapse property-definition-div" data-parent="#accordionReturn_value_desc" id="Return_value_desc">
    <div class="card-body pl-5">
    <h4>Desc</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Description of the rsync task.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule')" type="button"><span class="property-name">schedule</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule" id="Return_value_schedule">
    <div class="card-body pl-5">
    <h4>RsyncTaskSchedule</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Cron schedule for when the rsync task should run.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_schedule_minute">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_minute">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_minute" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_minute" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_minute')" type="button"><span class="property-name">minute</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_minute" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_minute" id="Return_value_schedule_minute">
    <div class="card-body pl-5">
    <h4>Minute</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    <span class="description"><p>Minute when the rsync task should run (cron format).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_hour">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_hour">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_hour" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_hour" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_hour')" type="button"><span class="property-name">hour</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_hour" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_hour" id="Return_value_schedule_hour">
    <div class="card-body pl-5">
    <h4>Hour</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"00" - "23"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_dom">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_dom">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_dom" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_dom" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_dom')" type="button"><span class="property-name">dom</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_dom" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_dom" id="Return_value_schedule_dom">
    <div class="card-body pl-5">
    <h4>Dom</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" - "31"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_month">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_month">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_month" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_month" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_month')" type="button"><span class="property-name">month</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_month" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_month" id="Return_value_schedule_month">
    <div class="card-body pl-5">
    <h4>Month</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (January) - "12" (December)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_dow">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_dow">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_dow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_dow" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_dow')" type="button"><span class="property-name">dow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_dow" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_dow" id="Return_value_schedule_dow">
    <div class="card-body pl-5">
    <h4>Dow</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (Monday) - "7" (Sunday)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_recursive">
    <div class="card">
    <div class="card-header" id="headingReturn_value_recursive">
    <h2 class="mb-0">
    <button aria-controls="Return_value_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_recursive" data-toggle="collapse" onclick="setAnchor('#Return_value_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_recursive" class="collapse property-definition-div" data-parent="#accordionReturn_value_recursive" id="Return_value_recursive">
    <div class="card-body pl-5">
    <h4>Recursive</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>Recursively transfer subdirectories.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_times">
    <div class="card">
    <div class="card-header" id="headingReturn_value_times">
    <h2 class="mb-0">
    <button aria-controls="Return_value_times" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_times" data-toggle="collapse" onclick="setAnchor('#Return_value_times')" type="button"><span class="property-name">times</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_times" class="collapse property-definition-div" data-parent="#accordionReturn_value_times" id="Return_value_times">
    <div class="card-body pl-5">
    <h4>Times</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>Preserve modification times of files.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_compress">
    <div class="card">
    <div class="card-header" id="headingReturn_value_compress">
    <h2 class="mb-0">
    <button aria-controls="Return_value_compress" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_compress" data-toggle="collapse" onclick="setAnchor('#Return_value_compress')" type="button"><span class="property-name">compress</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_compress" class="collapse property-definition-div" data-parent="#accordionReturn_value_compress" id="Return_value_compress">
    <div class="card-body pl-5">
    <h4>Compress</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>Reduce the size of the data to be transmitted.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_archive">
    <div class="card">
    <div class="card-header" id="headingReturn_value_archive">
    <h2 class="mb-0">
    <button aria-controls="Return_value_archive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_archive" data-toggle="collapse" onclick="setAnchor('#Return_value_archive')" type="button"><span class="property-name">archive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_archive" class="collapse property-definition-div" data-parent="#accordionReturn_value_archive" id="Return_value_archive">
    <div class="card-body pl-5">
    <h4>Archive</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>Make rsync run recursively, preserving symlinks, permissions, modification times, group, and special files.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_delete">
    <div class="card">
    <div class="card-header" id="headingReturn_value_delete">
    <h2 class="mb-0">
    <button aria-controls="Return_value_delete" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_delete" data-toggle="collapse" onclick="setAnchor('#Return_value_delete')" type="button"><span class="property-name">delete</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_delete" class="collapse property-definition-div" data-parent="#accordionReturn_value_delete" id="Return_value_delete">
    <div class="card-body pl-5">
    <h4>Delete</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>Delete files in the destination directory that do not exist in the source directory.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_quiet">
    <div class="card">
    <div class="card-header" id="headingReturn_value_quiet">
    <h2 class="mb-0">
    <button aria-controls="Return_value_quiet" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_quiet" data-toggle="collapse" onclick="setAnchor('#Return_value_quiet')" type="button"><span class="property-name">quiet</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_quiet" class="collapse property-definition-div" data-parent="#accordionReturn_value_quiet" id="Return_value_quiet">
    <div class="card-body pl-5">
    <h4>Quiet</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>Suppress informational messages from rsync.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_preserveperm">
    <div class="card">
    <div class="card-header" id="headingReturn_value_preserveperm">
    <h2 class="mb-0">
    <button aria-controls="Return_value_preserveperm" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_preserveperm" data-toggle="collapse" onclick="setAnchor('#Return_value_preserveperm')" type="button"><span class="property-name">preserveperm</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_preserveperm" class="collapse property-definition-div" data-parent="#accordionReturn_value_preserveperm" id="Return_value_preserveperm">
    <div class="card-body pl-5">
    <h4>Preserveperm</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>Preserve original file permissions.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_preserveattr">
    <div class="card">
    <div class="card-header" id="headingReturn_value_preserveattr">
    <h2 class="mb-0">
    <button aria-controls="Return_value_preserveattr" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_preserveattr" data-toggle="collapse" onclick="setAnchor('#Return_value_preserveattr')" type="button"><span class="property-name">preserveattr</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_preserveattr" class="collapse property-definition-div" data-parent="#accordionReturn_value_preserveattr" id="Return_value_preserveattr">
    <div class="card-body pl-5">
    <h4>Preserveattr</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>Preserve extended attributes of files.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_delayupdates">
    <div class="card">
    <div class="card-header" id="headingReturn_value_delayupdates">
    <h2 class="mb-0">
    <button aria-controls="Return_value_delayupdates" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_delayupdates" data-toggle="collapse" onclick="setAnchor('#Return_value_delayupdates')" type="button"><span class="property-name">delayupdates</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_delayupdates" class="collapse property-definition-div" data-parent="#accordionReturn_value_delayupdates" id="Return_value_delayupdates">
    <div class="card-body pl-5">
    <h4>Delayupdates</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>Delay updating destination files until all transfers are complete.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_extra">
    <div class="card">
    <div class="card-header" id="headingReturn_value_extra">
    <h2 class="mb-0">
    <button aria-controls="Return_value_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_extra" data-toggle="collapse" onclick="setAnchor('#Return_value_extra')" type="button"><span class="property-name">extra</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_extra" class="collapse property-definition-div" data-parent="#accordionReturn_value_extra" id="Return_value_extra">
    <div class="card-body pl-5">
    <h4>Extra</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of additional rsync command-line options.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_extra_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</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 this rsync task is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_locked">
    <div class="card">
    <div class="card-header" id="headingReturn_value_locked">
    <h2 class="mb-0">
    <button aria-controls="Return_value_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_locked" data-toggle="collapse" onclick="setAnchor('#Return_value_locked')" type="button"><span class="property-name">locked</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_locked" class="collapse property-definition-div" data-parent="#accordionReturn_value_locked" id="Return_value_locked">
    <div class="card-body pl-5">
    <h4>Locked</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether this rsync task is currently locked (running).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_job">
    <div class="card">
    <div class="card-header" id="headingReturn_value_job">
    <h2 class="mb-0">
    <button aria-controls="Return_value_job" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_job" data-toggle="collapse" onclick="setAnchor('#Return_value_job')" type="button"><span class="property-name">job</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_job" class="collapse property-definition-div" data-parent="#accordionReturn_value_job" id="Return_value_job">
    <div class="card-body pl-5">
    <h4>Job</h4><br/>
    <span class="description"><p>Information about the currently running job. <code>null</code> if no job is running.</p>
    </span><div class="any-of-value" id="Return_value_job_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_job_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_job_anyOf_i0" id="Return_value_job_anyOf_i0" onclick="setAnchor('#Return_value_job_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_job_anyOf_i1" id="Return_value_job_anyOf_i1" onclick="setAnchor('#Return_value_job_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_Return_value_job_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_job_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><br><br>

*Required roles:* SNAPSHOT_TASK_READ

