nvmet.global.update
===================

Update NVMe target global config.

.. 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: nvmet_update</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>nvmet_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_basenqn"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_basenqn"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_basenqn" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_basenqn" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_basenqn')" type="button"><span class="property-name">basenqn</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_basenqn" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_basenqn" id="Call_parameters_items_i0_basenqn"> <div class="card-body pl-5"> <h4>Basenqn</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>NQN to be used as the prefix on the creation of a subsystem, if a subnqn is not supplied to <code>nvmet.subsys.create</code>.</p> <p>Modifying this value will <em>not</em> change the subnqn of any existing subsystems.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_kernel"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_kernel"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_kernel" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_kernel" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_kernel')" type="button"><span class="property-name">kernel</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_kernel" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_kernel" id="Call_parameters_items_i0_kernel"> <div class="card-body pl-5"> <h4>Kernel</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Select the NVMe-oF backend.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_ana"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_ana"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_ana" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_ana" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_ana')" type="button"><span class="property-name">ana</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_ana" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_ana" id="Call_parameters_items_i0_ana"> <div class="card-body pl-5"> <h4>Ana</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Asymmetric Namespace Access (ANA) enabled.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_rdma"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_rdma"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_rdma" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_rdma" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_rdma')" type="button"><span class="property-name">rdma</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_rdma" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_rdma" id="Call_parameters_items_i0_rdma"> <div class="card-body pl-5"> <h4>Rdma</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>RDMA is enabled for NVMe-oF.</p> <p>Enabling is limited to TrueNAS Enterprise-licensed systems and requires the system and network environment have Remote Direct Memory Access (RDMA)-capable hardware.</p> <p>Once enabled one or more <code>ports</code> may be configured with RDMA selected as the transport. See <code>nvmet.port.create</code>.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_xport_referral"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_xport_referral"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_xport_referral" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_xport_referral" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_xport_referral')" type="button"><span class="property-name">xport_referral</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_xport_referral" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_xport_referral" id="Call_parameters_items_i0_xport_referral"> <div class="card-body pl-5"> <h4>Xport Referral</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Controls whether cross-port referrals will be generated for ports on this TrueNAS.</p> <p>If ANA is active then referrals will always be generated between the peer ports on each TrueNAS controller node.</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>NVMetGlobalEntry</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_basenqn"> <div class="card"> <div class="card-header" id="headingReturn_value_basenqn"> <h2 class="mb-0"> <button aria-controls="Return_value_basenqn" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_basenqn" data-toggle="collapse" onclick="setAnchor('#Return_value_basenqn')" type="button"><span class="property-name">basenqn</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_basenqn" class="collapse property-definition-div" data-parent="#accordionReturn_value_basenqn" id="Return_value_basenqn"> <div class="card-body pl-5"> <h4>Basenqn</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>NQN to be used as the prefix on the creation of a subsystem, if a subnqn is not supplied to <code>nvmet.subsys.create</code>.</p> <p>Modifying this value will <em>not</em> change the subnqn of any existing subsystems.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_kernel"> <div class="card"> <div class="card-header" id="headingReturn_value_kernel"> <h2 class="mb-0"> <button aria-controls="Return_value_kernel" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_kernel" data-toggle="collapse" onclick="setAnchor('#Return_value_kernel')" type="button"><span class="property-name">kernel</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_kernel" class="collapse property-definition-div" data-parent="#accordionReturn_value_kernel" id="Return_value_kernel"> <div class="card-body pl-5"> <h4>Kernel</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Select the NVMe-oF backend.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_ana"> <div class="card"> <div class="card-header" id="headingReturn_value_ana"> <h2 class="mb-0"> <button aria-controls="Return_value_ana" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ana" data-toggle="collapse" onclick="setAnchor('#Return_value_ana')" type="button"><span class="property-name">ana</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_ana" class="collapse property-definition-div" data-parent="#accordionReturn_value_ana" id="Return_value_ana"> <div class="card-body pl-5"> <h4>Ana</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Asymmetric Namespace Access (ANA) enabled.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_rdma"> <div class="card"> <div class="card-header" id="headingReturn_value_rdma"> <h2 class="mb-0"> <button aria-controls="Return_value_rdma" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_rdma" data-toggle="collapse" onclick="setAnchor('#Return_value_rdma')" type="button"><span class="property-name">rdma</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_rdma" class="collapse property-definition-div" data-parent="#accordionReturn_value_rdma" id="Return_value_rdma"> <div class="card-body pl-5"> <h4>Rdma</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>RDMA is enabled for NVMe-oF.</p> <p>Enabling is limited to TrueNAS Enterprise-licensed systems and requires the system and network environment have Remote Direct Memory Access (RDMA)-capable hardware.</p> <p>Once enabled one or more <code>ports</code> may be configured with RDMA selected as the transport. See <code>nvmet.port.create</code>.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_xport_referral"> <div class="card"> <div class="card-header" id="headingReturn_value_xport_referral"> <h2 class="mb-0"> <button aria-controls="Return_value_xport_referral" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_xport_referral" data-toggle="collapse" onclick="setAnchor('#Return_value_xport_referral')" type="button"><span class="property-name">xport_referral</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_xport_referral" class="collapse property-definition-div" data-parent="#accordionReturn_value_xport_referral" id="Return_value_xport_referral"> <div class="card-body pl-5"> <h4>Xport Referral</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Controls whether cross-port referrals will be generated for ports on this TrueNAS.</p> <p>If ANA is active then referrals will always be generated between the peer ports on each TrueNAS controller node.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* SHARING_NVME_TARGET_WRITE