cloudsync.sync_onetime
======================

Run cloud sync task without creating it.

.. 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: cloud_sync_sync_onetime</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>cloud_sync_sync_onetime</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="accordionCall_parameters_items_i0_description"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_description"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_description" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_description')" type="button"><span class="property-name">description</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_description" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_description" id="Call_parameters_items_i0_description"> <div class="card-body pl-5"> <h4>Description</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>The name of the task to display in the UI</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_path"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_path"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_path" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_path" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_path" id="Call_parameters_items_i0_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>The local path to back up beginning with <code>/mnt</code> or <code>/dev/zvol</code></p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_credentials"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_credentials"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_credentials" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_credentials" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_credentials')" type="button"><span class="property-name">credentials</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_credentials" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_credentials" id="Call_parameters_items_i0_credentials"> <div class="card-body pl-5"> <h4>Credentials</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>ID of the cloud credential</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_attributes"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_attributes"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_attributes" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_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="headingCall_parameters_items_i0_attributes" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_attributes" id="Call_parameters_items_i0_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>Additional information for each backup, e.g. bucket name</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_schedule"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule')" type="button"><span class="property-name">schedule</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule" id="Call_parameters_items_i0_schedule"> <div class="card-body pl-5"> <h4>CloudCron</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Cron schedule dictating when the task should run</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_schedule_minute"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule_minute"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule_minute" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_minute" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_minute')" type="button"><span class="property-name">minute</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule_minute" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_minute" id="Call_parameters_items_i0_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/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_schedule_hour"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule_hour"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule_hour" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_hour" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_hour')" type="button"><span class="property-name">hour</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule_hour" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_hour" id="Call_parameters_items_i0_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="accordionCall_parameters_items_i0_schedule_dom"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule_dom"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule_dom" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_dom" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_dom')" type="button"><span class="property-name">dom</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule_dom" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_dom" id="Call_parameters_items_i0_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="accordionCall_parameters_items_i0_schedule_month"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule_month"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule_month" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_month" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_month')" type="button"><span class="property-name">month</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule_month" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_month" id="Call_parameters_items_i0_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="accordionCall_parameters_items_i0_schedule_dow"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_schedule_dow"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_schedule_dow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_dow" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_dow')" type="button"><span class="property-name">dow</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_schedule_dow" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_dow" id="Call_parameters_items_i0_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="accordionCall_parameters_items_i0_pre_script"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_pre_script"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_pre_script" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pre_script" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pre_script')" type="button"><span class="property-name">pre_script</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_pre_script" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pre_script" id="Call_parameters_items_i0_pre_script"> <div class="card-body pl-5"> <h4>Pre Script</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>A Bash script to run immediately before every backup</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_post_script"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_post_script"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_post_script" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_post_script" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_post_script')" type="button"><span class="property-name">post_script</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_post_script" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_post_script" id="Call_parameters_items_i0_post_script"> <div class="card-body pl-5"> <h4>Post Script</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>A Bash script to run immediately after every backup if it succeeds</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_snapshot"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_snapshot"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_snapshot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_snapshot" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_snapshot')" type="button"><span class="property-name">snapshot</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_snapshot" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_snapshot" id="Call_parameters_items_i0_snapshot"> <div class="card-body pl-5"> <h4>Snapshot</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 to create a temporary snapshot of the dataset before every backup</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_include"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_include"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_include" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_include" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_include')" type="button"><span class="property-name">include</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_include" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_include" id="Call_parameters_items_i0_include"> <div class="card-body pl-5"> <h4>Include</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Paths to pass to <code>restic backup --include</code></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_i0_include_items"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_include_items_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_exclude"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_exclude"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_exclude')" type="button"><span class="property-name">exclude</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_exclude" id="Call_parameters_items_i0_exclude"> <div class="card-body pl-5"> <h4>Exclude</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="description"><p>Paths to pass to <code>restic backup --exclude</code></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_i0_exclude_items"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_exclude_items_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_args"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_args"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_args" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_args" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_args')" type="button"><span class="property-name">args</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_args" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_args" id="Call_parameters_items_i0_args"> <div class="card-body pl-5"> <h4>Args</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>(Slated for removal)</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_enabled"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_enabled"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_enabled')" type="button"><span class="property-name">enabled</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_enabled" id="Call_parameters_items_i0_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>Can enable/disable the task</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_bwlimit"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_bwlimit"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_bwlimit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_bwlimit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_bwlimit')" type="button"><span class="property-name">bwlimit</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_bwlimit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_bwlimit" id="Call_parameters_items_i0_bwlimit"> <div class="card-body pl-5"> <h4>Bwlimit</h4><span class="badge badge-dark value-type">Type: array of object</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_i0_bwlimit_items"> <h4>CloudSyncBwlimit</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="accordionCall_parameters_items_i0_bwlimit_items_time"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_bwlimit_items_time"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_bwlimit_items_time" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_bwlimit_items_time" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_bwlimit_items_time')" type="button"><span class="property-name">time</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_bwlimit_items_time" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_bwlimit_items_time" id="Call_parameters_items_i0_bwlimit_items_time"> <div class="card-body pl-5"> <h4>Time</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_bwlimit_items_bandwidth"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_bwlimit_items_bandwidth"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_bwlimit_items_bandwidth" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_bwlimit_items_bandwidth" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_bwlimit_items_bandwidth')" type="button"><span class="property-name">bandwidth</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_bwlimit_items_bandwidth" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_bwlimit_items_bandwidth" id="Call_parameters_items_i0_bwlimit_items_bandwidth"> <div class="card-body pl-5"> <h4>Bandwidth</h4><br/> <div class="any-of-value" id="Call_parameters_items_i0_bwlimit_items_bandwidth_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_bwlimit_items_bandwidth_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_bwlimit_items_bandwidth_anyOf_i0" id="Call_parameters_items_i0_bwlimit_items_bandwidth_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_bwlimit_items_bandwidth_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_bwlimit_items_bandwidth_anyOf_i1" id="Call_parameters_items_i0_bwlimit_items_bandwidth_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_bwlimit_items_bandwidth_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_bwlimit_items_bandwidth_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_bwlimit_items_bandwidth_anyOf_i0_number">Value must be strictly greater than <code>0</code></span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_bwlimit_items_bandwidth_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_transfers"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_transfers"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_transfers" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_transfers" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_transfers')" type="button"><span class="property-name">transfers</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_transfers" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_transfers" id="Call_parameters_items_i0_transfers"> <div class="card-body pl-5"> <h4>Transfers</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_transfers_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_transfers_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_transfers_anyOf_i0" id="Call_parameters_items_i0_transfers_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_transfers_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_transfers_anyOf_i1" id="Call_parameters_items_i0_transfers_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_transfers_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_transfers_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_transfers_anyOf_i0_number">Value must be strictly greater than <code>0</code></span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_transfers_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_direction"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_direction"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_direction" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_direction" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_direction')" type="button"><span class="property-name">direction</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_direction" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_direction" id="Call_parameters_items_i0_direction"> <div class="card-body pl-5"> <h4>Direction</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Call_parameters_items_i0_direction_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"PUSH"</li><li class="list-group-item enum-item">"PULL"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_transfer_mode"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_transfer_mode"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_transfer_mode" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_transfer_mode" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_transfer_mode')" type="button"><span class="property-name">transfer_mode</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_transfer_mode" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_transfer_mode" id="Call_parameters_items_i0_transfer_mode"> <div class="card-body pl-5"> <h4>Transfer Mode</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Call_parameters_items_i0_transfer_mode_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SYNC"</li><li class="list-group-item enum-item">"COPY"</li><li class="list-group-item enum-item">"MOVE"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_encryption"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_encryption"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_encryption" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_encryption" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_encryption')" type="button"><span class="property-name">encryption</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_encryption" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_encryption" id="Call_parameters_items_i0_encryption"> <div class="card-body pl-5"> <h4>Encryption</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_filename_encryption"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_filename_encryption"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_filename_encryption" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_filename_encryption" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_filename_encryption')" type="button"><span class="property-name">filename_encryption</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_filename_encryption" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_filename_encryption" id="Call_parameters_items_i0_filename_encryption"> <div class="card-body pl-5"> <h4>Filename Encryption</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_encryption_password"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_encryption_password"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_encryption_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_encryption_password" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_encryption_password')" type="button"><span class="property-name">encryption_password</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_encryption_password" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_encryption_password" id="Call_parameters_items_i0_encryption_password"> <div class="card-body pl-5"> <h4>Encryption Password</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_encryption_salt"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_encryption_salt"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_encryption_salt" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_encryption_salt" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_encryption_salt')" type="button"><span class="property-name">encryption_salt</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_encryption_salt" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_encryption_salt" id="Call_parameters_items_i0_encryption_salt"> <div class="card-body pl-5"> <h4>Encryption Salt</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_create_empty_src_dirs"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_create_empty_src_dirs"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_create_empty_src_dirs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_create_empty_src_dirs" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_create_empty_src_dirs')" type="button"><span class="property-name">create_empty_src_dirs</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_create_empty_src_dirs" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_create_empty_src_dirs" id="Call_parameters_items_i0_create_empty_src_dirs"> <div class="card-body pl-5"> <h4>Create Empty Src Dirs</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_follow_symlinks"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_follow_symlinks"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_follow_symlinks" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_follow_symlinks" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_follow_symlinks')" type="button"><span class="property-name">follow_symlinks</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_follow_symlinks" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_follow_symlinks" id="Call_parameters_items_i0_follow_symlinks"> <div class="card-body pl-5"> <h4>Follow Symlinks</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> </div> </div> <h5>Parameter 2: cloud_sync_sync_onetime_options</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>cloud_sync_sync_onetime_options</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="accordionCall_parameters_items_i1_dry_run"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_dry_run"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_dry_run" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_dry_run" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_dry_run')" type="button"><span class="property-name">dry_run</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_dry_run" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_dry_run" id="Call_parameters_items_i1_dry_run"> <div class="card-body pl-5"> <h4>Dry Run</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><span class="badge badge-dark value-type">Type: null</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* CLOUD_SYNC_WRITE