truecommand.update
==================

Update Truecommand service settings.

`api_key` is a valid API key generated by iX Portal.

.. 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: truecommand_update</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>truecommand_update</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_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><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_api_key"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_api_key"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_api_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_api_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_api_key')" type="button"><span class="property-name">api_key</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_api_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_api_key" id="Call_parameters_items_i0_api_key"> <div class="card-body pl-5"> <h4>Api Key</h4><br/> <div class="any-of-value" id="Call_parameters_items_i0_api_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_api_key_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_api_key_anyOf_i0" id="Call_parameters_items_i0_api_key_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_api_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_Call_parameters_items_i0_api_key_anyOf_i1" id="Call_parameters_items_i0_api_key_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_api_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_Call_parameters_items_i0_api_key_anyOf_i0" role="tabpanel"> <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_api_key_anyOf_i0_minLength">Must be at least <code>16</code> characters long</span></p><p><span class="badge badge-light restriction max-length-restriction" id="Call_parameters_items_i0_api_key_anyOf_i0_maxLength">Must be at most <code>16</code> characters long</span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_api_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> </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>TruecommandEntry</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/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_api_key"> <div class="card"> <div class="card-header" id="headingReturn_value_api_key"> <h2 class="mb-0"> <button aria-controls="Return_value_api_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_api_key" data-toggle="collapse" onclick="setAnchor('#Return_value_api_key')" type="button"><span class="property-name">api_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_api_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_api_key" id="Return_value_api_key"> <div class="card-body pl-5"> <h4>Api Key</h4><br/> <div class="any-of-value" id="Return_value_api_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_api_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_api_key_anyOf_i0" id="Return_value_api_key_anyOf_i0" onclick="setAnchor('#Return_value_api_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_api_key_anyOf_i1" id="Return_value_api_key_anyOf_i1" onclick="setAnchor('#Return_value_api_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_api_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_api_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_status"> <div class="card"> <div class="card-header" id="headingReturn_value_status"> <h2 class="mb-0"> <button aria-controls="Return_value_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status" data-toggle="collapse" onclick="setAnchor('#Return_value_status')" type="button"><span class="property-name">status</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_status" id="Return_value_status"> <div class="card-body pl-5"> <h4>Status</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Return_value_status_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"CONNECTED"</li><li class="list-group-item enum-item">"CONNECTING"</li><li class="list-group-item enum-item">"DISABLED"</li><li class="list-group-item enum-item">"FAILED"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_status_reason"> <div class="card"> <div class="card-header" id="headingReturn_value_status_reason"> <h2 class="mb-0"> <button aria-controls="Return_value_status_reason" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status_reason" data-toggle="collapse" onclick="setAnchor('#Return_value_status_reason')" type="button"><span class="property-name">status_reason</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_status_reason" class="collapse property-definition-div" data-parent="#accordionReturn_value_status_reason" id="Return_value_status_reason"> <div class="card-body pl-5"> <h4>Status Reason</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Return_value_status_reason_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"Truecommand service is connected."</li><li class="list-group-item enum-item">"Pending Confirmation From iX Portal for Truecommand API Key."</li><li class="list-group-item enum-item">"Truecommand service is disabled."</li><li class="list-group-item enum-item">"Truecommand API Key Disabled by iX Portal."</li><li class="list-group-item enum-item">"Waiting for connection from Truecommand."</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_remote_url"> <div class="card"> <div class="card-header" id="headingReturn_value_remote_url"> <h2 class="mb-0"> <button aria-controls="Return_value_remote_url" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remote_url" data-toggle="collapse" onclick="setAnchor('#Return_value_remote_url')" type="button"><span class="property-name">remote_url</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_remote_url" class="collapse property-definition-div" data-parent="#accordionReturn_value_remote_url" id="Return_value_remote_url"> <div class="card-body pl-5"> <h4>Remote Url</h4><br/> <div class="any-of-value" id="Return_value_remote_url_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_remote_url_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remote_url_anyOf_i0" id="Return_value_remote_url_anyOf_i0" onclick="setAnchor('#Return_value_remote_url_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_remote_url_anyOf_i1" id="Return_value_remote_url_anyOf_i1" onclick="setAnchor('#Return_value_remote_url_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_remote_url_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_remote_url_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_remote_ip_address"> <div class="card"> <div class="card-header" id="headingReturn_value_remote_ip_address"> <h2 class="mb-0"> <button aria-controls="Return_value_remote_ip_address" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_remote_ip_address" data-toggle="collapse" onclick="setAnchor('#Return_value_remote_ip_address')" type="button"><span class="property-name">remote_ip_address</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_remote_ip_address" class="collapse property-definition-div" data-parent="#accordionReturn_value_remote_ip_address" id="Return_value_remote_ip_address"> <div class="card-body pl-5"> <h4>Remote Ip Address</h4><br/> <div class="any-of-value" id="Return_value_remote_ip_address_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_remote_ip_address_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_remote_ip_address_anyOf_i0" id="Return_value_remote_ip_address_anyOf_i0" onclick="setAnchor('#Return_value_remote_ip_address_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_remote_ip_address_anyOf_i1" id="Return_value_remote_ip_address_anyOf_i1" onclick="setAnchor('#Return_value_remote_ip_address_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_remote_ip_address_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_remote_ip_address_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_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> <span class="badge badge-warning required-property">Required</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><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* TRUECOMMAND_WRITE