iscsi.global.update
===================

`alua` is a no-op for FreeNAS.

.. 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: iscsi_update</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>iscsi_update</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>ISCSIGlobalUpdateArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_basename">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_basename">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_basename" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_basename" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_basename')" type="button"><span class="property-name">basename</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_basename" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_basename" id="Call_parameters_items_i0_basename">
    <div class="card-body pl-5">
    <h4>Basename</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Base name prefix for iSCSI target IQNs.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_isns_servers">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_isns_servers">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_isns_servers" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_isns_servers" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_isns_servers')" type="button"><span class="property-name">isns_servers</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_isns_servers" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_isns_servers" id="Call_parameters_items_i0_isns_servers">
    <div class="card-body pl-5">
    <h4>Isns Servers</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of iSNS (Internet Storage Name Service) server addresses.</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_isns_servers_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_listen_port">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_listen_port">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_listen_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_listen_port" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_listen_port')" type="button"><span class="property-name">listen_port</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_listen_port" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_listen_port" id="Call_parameters_items_i0_listen_port">
    <div class="card-body pl-5">
    <h4>Listen Port</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>TCP port number for iSCSI connections.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_listen_port_number">Value must be greater or equal to <code>1025</code> and lesser or equal to <code>65535</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_pool_avail_threshold">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_pool_avail_threshold">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_pool_avail_threshold" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pool_avail_threshold" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pool_avail_threshold')" type="button"><span class="property-name">pool_avail_threshold</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_pool_avail_threshold" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pool_avail_threshold" id="Call_parameters_items_i0_pool_avail_threshold">
    <div class="card-body pl-5">
    <h4>Pool Avail Threshold</h4><br/>
    <span class="description"><p>Pool available space threshold percentage or <code>null</code> to disable.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_pool_avail_threshold_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_pool_avail_threshold_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_pool_avail_threshold_anyOf_i0" id="Call_parameters_items_i0_pool_avail_threshold_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_pool_avail_threshold_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_pool_avail_threshold_anyOf_i1" id="Call_parameters_items_i0_pool_avail_threshold_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_pool_avail_threshold_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_pool_avail_threshold_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_pool_avail_threshold_anyOf_i0_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>99</code></span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_pool_avail_threshold_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_alua">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_alua">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_alua" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_alua" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_alua')" type="button"><span class="property-name">alua</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_alua" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_alua" id="Call_parameters_items_i0_alua">
    <div class="card-body pl-5">
    <h4>Alua</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether Asymmetric Logical Unit Access (ALUA) is enabled. Enabling is limited to TrueNAS Enterprise-licensed     high availability systems. ALUA only works when configured on both the client and server.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_iser">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_iser">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_iser" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_iser" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_iser')" type="button"><span class="property-name">iser</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_iser" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_iser" id="Call_parameters_items_i0_iser">
    <div class="card-body pl-5">
    <h4>Iser</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether iSCSI Extensions for RDMA (iSER) are enabled. Enabling is limited to TrueNAS Enterprise-licensed     systems and requires the system and network environment have Remote Direct Memory Access (RDMA)-capable hardware.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_direct_config">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_direct_config">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_direct_config" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_direct_config" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_direct_config')" type="button"><span class="property-name">direct_config</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_direct_config" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_direct_config" id="Call_parameters_items_i0_direct_config">
    <div class="card-body pl-5">
    <h4>Direct Config</h4><br/>
    <span class="description"><p>Whether configuration is written into the kernel directly by middlewared.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_direct_config_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_direct_config_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_direct_config_anyOf_i0" id="Call_parameters_items_i0_direct_config_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_direct_config_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_direct_config_anyOf_i1" id="Call_parameters_items_i0_direct_config_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_direct_config_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_direct_config_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_direct_config_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>ISCSIGlobalEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated global iSCSI configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Unique identifier for the global iSCSI configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_basename">
    <div class="card">
    <div class="card-header" id="headingReturn_value_basename">
    <h2 class="mb-0">
    <button aria-controls="Return_value_basename" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_basename" data-toggle="collapse" onclick="setAnchor('#Return_value_basename')" type="button"><span class="property-name">basename</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_basename" class="collapse property-definition-div" data-parent="#accordionReturn_value_basename" id="Return_value_basename">
    <div class="card-body pl-5">
    <h4>Basename</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Base name prefix for iSCSI target IQNs.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_isns_servers">
    <div class="card">
    <div class="card-header" id="headingReturn_value_isns_servers">
    <h2 class="mb-0">
    <button aria-controls="Return_value_isns_servers" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_isns_servers" data-toggle="collapse" onclick="setAnchor('#Return_value_isns_servers')" type="button"><span class="property-name">isns_servers</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_isns_servers" class="collapse property-definition-div" data-parent="#accordionReturn_value_isns_servers" id="Return_value_isns_servers">
    <div class="card-body pl-5">
    <h4>Isns Servers</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of iSNS (Internet Storage Name Service) server addresses.</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_isns_servers_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_listen_port">
    <div class="card">
    <div class="card-header" id="headingReturn_value_listen_port">
    <h2 class="mb-0">
    <button aria-controls="Return_value_listen_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_listen_port" data-toggle="collapse" onclick="setAnchor('#Return_value_listen_port')" type="button"><span class="property-name">listen_port</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_listen_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_listen_port" id="Return_value_listen_port">
    <div class="card-body pl-5">
    <h4>Listen Port</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 3260</span><br/>
    <span class="description"><p>TCP port number for iSCSI connections.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_listen_port_number">Value must be greater or equal to <code>1025</code> and lesser or equal to <code>65535</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_pool_avail_threshold">
    <div class="card">
    <div class="card-header" id="headingReturn_value_pool_avail_threshold">
    <h2 class="mb-0">
    <button aria-controls="Return_value_pool_avail_threshold" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool_avail_threshold" data-toggle="collapse" onclick="setAnchor('#Return_value_pool_avail_threshold')" type="button"><span class="property-name">pool_avail_threshold</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_pool_avail_threshold" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool_avail_threshold" id="Return_value_pool_avail_threshold">
    <div class="card-body pl-5">
    <h4>Pool Avail Threshold</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Pool available space threshold percentage or <code>null</code> to disable.</p>
    </span><div class="any-of-value" id="Return_value_pool_avail_threshold_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_pool_avail_threshold_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_pool_avail_threshold_anyOf_i0" id="Return_value_pool_avail_threshold_anyOf_i0" onclick="setAnchor('#Return_value_pool_avail_threshold_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_pool_avail_threshold_anyOf_i1" id="Return_value_pool_avail_threshold_anyOf_i1" onclick="setAnchor('#Return_value_pool_avail_threshold_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_pool_avail_threshold_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="Return_value_pool_avail_threshold_anyOf_i0_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>99</code></span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_pool_avail_threshold_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_alua">
    <div class="card">
    <div class="card-header" id="headingReturn_value_alua">
    <h2 class="mb-0">
    <button aria-controls="Return_value_alua" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_alua" data-toggle="collapse" onclick="setAnchor('#Return_value_alua')" type="button"><span class="property-name">alua</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_alua" class="collapse property-definition-div" data-parent="#accordionReturn_value_alua" id="Return_value_alua">
    <div class="card-body pl-5">
    <h4>Alua</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether Asymmetric Logical Unit Access (ALUA) is enabled. Enabling is limited to TrueNAS Enterprise-licensed     high availability systems. ALUA only works when configured on both the client and server.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_iser">
    <div class="card">
    <div class="card-header" id="headingReturn_value_iser">
    <h2 class="mb-0">
    <button aria-controls="Return_value_iser" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_iser" data-toggle="collapse" onclick="setAnchor('#Return_value_iser')" type="button"><span class="property-name">iser</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_iser" class="collapse property-definition-div" data-parent="#accordionReturn_value_iser" id="Return_value_iser">
    <div class="card-body pl-5">
    <h4>Iser</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether iSCSI Extensions for RDMA (iSER) are enabled. Enabling is limited to TrueNAS Enterprise-licensed     systems and requires the system and network environment have Remote Direct Memory Access (RDMA)-capable hardware.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_direct_config">
    <div class="card">
    <div class="card-header" id="headingReturn_value_direct_config">
    <h2 class="mb-0">
    <button aria-controls="Return_value_direct_config" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_direct_config" data-toggle="collapse" onclick="setAnchor('#Return_value_direct_config')" type="button"><span class="property-name">direct_config</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_direct_config" class="collapse property-definition-div" data-parent="#accordionReturn_value_direct_config" id="Return_value_direct_config">
    <div class="card-body pl-5">
    <h4>Direct Config</h4><br/>
    <span class="description"><p>Whether configuration is written into the kernel directly by middlewared.</p>
    </span><div class="any-of-value" id="Return_value_direct_config_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_direct_config_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_direct_config_anyOf_i0" id="Return_value_direct_config_anyOf_i0" onclick="setAnchor('#Return_value_direct_config_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_direct_config_anyOf_i1" id="Return_value_direct_config_anyOf_i1" onclick="setAnchor('#Return_value_direct_config_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_direct_config_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_direct_config_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:* SHARING_ISCSI_GLOBAL_WRITE

