nvmet.subsys.create
===================

Create a NVMe target subsystem (`subsys`).

When a `subsys` contains one of more `namespaces`, and is associated with one or more `ports` then clients may access the storage using NVMe-oF.

All clients may access the subsystem if the `allow_any_host` attribute is set.  Otherwise, access is only permitted to `hosts` who have been associated with the subsystem.

See `nvmet.host.create` and `nvmet.host_subsys.create`.

.. 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_subsys_create</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>nvmet_subsys_create</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Configuration data for creating a new NVMe-oF subsystem.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_name"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_name"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_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="headingCall_parameters_items_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_name" id="Call_parameters_items_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>Human readable name for the subsystem.</p> <p>If <code>subnqn</code> is not provided on creation, then this name will be appended to the <code>basenqn</code> from <code>nvmet.global.config</code> to generate a subnqn.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_subnqn"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_subnqn"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_subnqn" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_subnqn" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_subnqn')" type="button"><span class="property-name">subnqn</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_subnqn" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_subnqn" id="Call_parameters_items_i0_subnqn"> <div class="card-body pl-5"> <h4>Subnqn</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>NVMe Qualified Name (NQN) for the subsystem.</p> <p>Must be a valid NQN format if provided.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_subnqn_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_subnqn_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_subnqn_anyOf_i0" id="Call_parameters_items_i0_subnqn_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_subnqn_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_subnqn_anyOf_i1" id="Call_parameters_items_i0_subnqn_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_subnqn_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_subnqn_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_subnqn_anyOf_i0_minLength">Must be at least <code>11</code> characters long</span></p><p><span class="badge badge-light restriction max-length-restriction" id="Call_parameters_items_i0_subnqn_anyOf_i0_maxLength">Must be at most <code>223</code> characters long</span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_subnqn_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_allow_any_host"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_allow_any_host"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_allow_any_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_allow_any_host" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_allow_any_host')" type="button"><span class="property-name">allow_any_host</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_allow_any_host" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_allow_any_host" id="Call_parameters_items_i0_allow_any_host"> <div class="card-body pl-5"> <h4>Allow Any Host</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>Any host can access the storage associated with this subsystem (i.e. no access control).</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_pi_enable"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_pi_enable"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_pi_enable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pi_enable" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pi_enable')" type="button"><span class="property-name">pi_enable</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_pi_enable" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pi_enable" id="Call_parameters_items_i0_pi_enable"> <div class="card-body pl-5"> <h4>Pi Enable</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Enable Protection Information (PI) for data integrity checking.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_pi_enable_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_pi_enable_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_pi_enable_anyOf_i0" id="Call_parameters_items_i0_pi_enable_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_pi_enable_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_pi_enable_anyOf_i1" id="Call_parameters_items_i0_pi_enable_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_pi_enable_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_pi_enable_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_pi_enable_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_qid_max"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_qid_max"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_qid_max" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_qid_max" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_qid_max')" type="button"><span class="property-name">qid_max</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_qid_max" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_qid_max" id="Call_parameters_items_i0_qid_max"> <div class="card-body pl-5"> <h4>Qid Max</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Maximum number of queue IDs allowed for this subsystem.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_qid_max_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_qid_max_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_qid_max_anyOf_i0" id="Call_parameters_items_i0_qid_max_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_qid_max_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_qid_max_anyOf_i1" id="Call_parameters_items_i0_qid_max_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_qid_max_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_qid_max_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_Call_parameters_items_i0_qid_max_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_ieee_oui"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_ieee_oui"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_ieee_oui" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_ieee_oui" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_ieee_oui')" type="button"><span class="property-name">ieee_oui</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_ieee_oui" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_ieee_oui" id="Call_parameters_items_i0_ieee_oui"> <div class="card-body pl-5"> <h4>Ieee Oui</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>IEEE Organizationally Unique Identifier for the subsystem.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_ieee_oui_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_ieee_oui_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_ieee_oui_anyOf_i0" id="Call_parameters_items_i0_ieee_oui_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_ieee_oui_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_ieee_oui_anyOf_i1" id="Call_parameters_items_i0_ieee_oui_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_ieee_oui_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_ieee_oui_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_i0_ieee_oui_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_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-success default-value">Default: null</span><br/> <span class="description"><p>If set to either <code>True</code> or <code>False</code>, then <em>override</em> the global <code>ana</code> setting from <code>nvmet.global.config</code> for this subsystem only.</p> <p>If <code>null</code>, then the global <code>ana</code> setting will take effect.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_ana_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_ana_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_ana_anyOf_i0" id="Call_parameters_items_i0_ana_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_ana_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_ana_anyOf_i1" id="Call_parameters_items_i0_ana_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_ana_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_ana_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_ana_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>NVMetSubsysEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>The newly created NVMe-oF subsystem 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 NVMe-oF subsystem.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_name"> <div class="card"> <div class="card-header" id="headingReturn_value_name"> <h2 class="mb-0"> <button aria-controls="Return_value_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_name" data-toggle="collapse" onclick="setAnchor('#Return_value_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_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_name" id="Return_value_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>Human readable name for the subsystem.</p> <p>If <code>subnqn</code> is not provided on creation, then this name will be appended to the <code>basenqn</code> from <code>nvmet.global.config</code> to generate a subnqn.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_subnqn"> <div class="card"> <div class="card-header" id="headingReturn_value_subnqn"> <h2 class="mb-0"> <button aria-controls="Return_value_subnqn" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_subnqn" data-toggle="collapse" onclick="setAnchor('#Return_value_subnqn')" type="button"><span class="property-name">subnqn</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_subnqn" class="collapse property-definition-div" data-parent="#accordionReturn_value_subnqn" id="Return_value_subnqn"> <div class="card-body pl-5"> <h4>Subnqn</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>NVMe Qualified Name (NQN) for the subsystem.</p> <p>If not provided during creation, will be auto-generated by appending the <code>name</code> to the <code>basenqn</code> from <code>nvmet.global.config</code>.</p> </span><div class="any-of-value" id="Return_value_subnqn_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_subnqn_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_subnqn_anyOf_i0" id="Return_value_subnqn_anyOf_i0" onclick="setAnchor('#Return_value_subnqn_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_subnqn_anyOf_i1" id="Return_value_subnqn_anyOf_i1" onclick="setAnchor('#Return_value_subnqn_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_subnqn_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="Return_value_subnqn_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_subnqn_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_serial"> <div class="card"> <div class="card-header" id="headingReturn_value_serial"> <h2 class="mb-0"> <button aria-controls="Return_value_serial" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_serial" data-toggle="collapse" onclick="setAnchor('#Return_value_serial')" type="button"><span class="property-name">serial</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_serial" class="collapse property-definition-div" data-parent="#accordionReturn_value_serial" id="Return_value_serial"> <div class="card-body pl-5"> <h4>Serial</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Serial number assigned to the subsystem.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_allow_any_host"> <div class="card"> <div class="card-header" id="headingReturn_value_allow_any_host"> <h2 class="mb-0"> <button aria-controls="Return_value_allow_any_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_allow_any_host" data-toggle="collapse" onclick="setAnchor('#Return_value_allow_any_host')" type="button"><span class="property-name">allow_any_host</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_allow_any_host" class="collapse property-definition-div" data-parent="#accordionReturn_value_allow_any_host" id="Return_value_allow_any_host"> <div class="card-body pl-5"> <h4>Allow Any Host</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>Any host can access the storage associated with this subsystem (i.e. no access control).</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_pi_enable"> <div class="card"> <div class="card-header" id="headingReturn_value_pi_enable"> <h2 class="mb-0"> <button aria-controls="Return_value_pi_enable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pi_enable" data-toggle="collapse" onclick="setAnchor('#Return_value_pi_enable')" type="button"><span class="property-name">pi_enable</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_pi_enable" class="collapse property-definition-div" data-parent="#accordionReturn_value_pi_enable" id="Return_value_pi_enable"> <div class="card-body pl-5"> <h4>Pi Enable</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Enable Protection Information (PI) for data integrity checking.</p> </span><div class="any-of-value" id="Return_value_pi_enable_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_pi_enable_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_pi_enable_anyOf_i0" id="Return_value_pi_enable_anyOf_i0" onclick="setAnchor('#Return_value_pi_enable_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_pi_enable_anyOf_i1" id="Return_value_pi_enable_anyOf_i1" onclick="setAnchor('#Return_value_pi_enable_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_pi_enable_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_pi_enable_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_qid_max"> <div class="card"> <div class="card-header" id="headingReturn_value_qid_max"> <h2 class="mb-0"> <button aria-controls="Return_value_qid_max" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_qid_max" data-toggle="collapse" onclick="setAnchor('#Return_value_qid_max')" type="button"><span class="property-name">qid_max</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_qid_max" class="collapse property-definition-div" data-parent="#accordionReturn_value_qid_max" id="Return_value_qid_max"> <div class="card-body pl-5"> <h4>Qid Max</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Maximum number of queue IDs allowed for this subsystem.</p> </span><div class="any-of-value" id="Return_value_qid_max_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_qid_max_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_qid_max_anyOf_i0" id="Return_value_qid_max_anyOf_i0" onclick="setAnchor('#Return_value_qid_max_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_qid_max_anyOf_i1" id="Return_value_qid_max_anyOf_i1" onclick="setAnchor('#Return_value_qid_max_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_qid_max_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_qid_max_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_ieee_oui"> <div class="card"> <div class="card-header" id="headingReturn_value_ieee_oui"> <h2 class="mb-0"> <button aria-controls="Return_value_ieee_oui" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ieee_oui" data-toggle="collapse" onclick="setAnchor('#Return_value_ieee_oui')" type="button"><span class="property-name">ieee_oui</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_ieee_oui" class="collapse property-definition-div" data-parent="#accordionReturn_value_ieee_oui" id="Return_value_ieee_oui"> <div class="card-body pl-5"> <h4>Ieee Oui</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>IEEE Organizationally Unique Identifier for the subsystem.</p> </span><div class="any-of-value" id="Return_value_ieee_oui_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_ieee_oui_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ieee_oui_anyOf_i0" id="Return_value_ieee_oui_anyOf_i0" onclick="setAnchor('#Return_value_ieee_oui_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_ieee_oui_anyOf_i1" id="Return_value_ieee_oui_anyOf_i1" onclick="setAnchor('#Return_value_ieee_oui_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_ieee_oui_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_ieee_oui_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_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></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-success default-value">Default: null</span><br/> <span class="description"><p>If set to either <code>True</code> or <code>False</code>, then <em>override</em> the global <code>ana</code> setting from <code>nvmet.global.config</code> for this subsystem only.</p> <p>If <code>null</code>, then the global <code>ana</code> setting will take effect.</p> </span><div class="any-of-value" id="Return_value_ana_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_ana_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ana_anyOf_i0" id="Return_value_ana_anyOf_i0" onclick="setAnchor('#Return_value_ana_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_ana_anyOf_i1" id="Return_value_ana_anyOf_i1" onclick="setAnchor('#Return_value_ana_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_ana_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_ana_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_hosts"> <div class="card"> <div class="card-header" id="headingReturn_value_hosts"> <h2 class="mb-0"> <button aria-controls="Return_value_hosts" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_hosts" data-toggle="collapse" onclick="setAnchor('#Return_value_hosts')" type="button"><span class="property-name">hosts</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_hosts" class="collapse property-definition-div" data-parent="#accordionReturn_value_hosts" id="Return_value_hosts"> <div class="card-body pl-5"> <h4>Hosts</h4> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>List of host ids which have access to this subsystem.</p> <p>Only populated on query if <code>extra.options.verbose</code> is set.</p> </span><div class="any-of-value" id="Return_value_hosts_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_hosts_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_hosts_anyOf_i0" id="Return_value_hosts_anyOf_i0" onclick="setAnchor('#Return_value_hosts_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_hosts_anyOf_i1" id="Return_value_hosts_anyOf_i1" onclick="setAnchor('#Return_value_hosts_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_hosts_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: array of integer</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="Return_value_hosts_anyOf_i0_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_hosts_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_namespaces"> <div class="card"> <div class="card-header" id="headingReturn_value_namespaces"> <h2 class="mb-0"> <button aria-controls="Return_value_namespaces" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_namespaces" data-toggle="collapse" onclick="setAnchor('#Return_value_namespaces')" type="button"><span class="property-name">namespaces</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_namespaces" class="collapse property-definition-div" data-parent="#accordionReturn_value_namespaces" id="Return_value_namespaces"> <div class="card-body pl-5"> <h4>Namespaces</h4> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>List of namespaces ids in this subsystem.</p> <p>Only populated on query if <code>extra.options.verbose</code> is set.</p> </span><div class="any-of-value" id="Return_value_namespaces_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_namespaces_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_namespaces_anyOf_i0" id="Return_value_namespaces_anyOf_i0" onclick="setAnchor('#Return_value_namespaces_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_namespaces_anyOf_i1" id="Return_value_namespaces_anyOf_i1" onclick="setAnchor('#Return_value_namespaces_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_namespaces_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: array of integer</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="Return_value_namespaces_anyOf_i0_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_namespaces_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_ports"> <div class="card"> <div class="card-header" id="headingReturn_value_ports"> <h2 class="mb-0"> <button aria-controls="Return_value_ports" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ports" data-toggle="collapse" onclick="setAnchor('#Return_value_ports')" type="button"><span class="property-name">ports</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_ports" class="collapse property-definition-div" data-parent="#accordionReturn_value_ports" id="Return_value_ports"> <div class="card-body pl-5"> <h4>Ports</h4> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>List of ports ids on which this subsystem is available.</p> <p>Only populated on query if <code>extra.options.verbose</code> is set.</p> </span><div class="any-of-value" id="Return_value_ports_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_ports_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_ports_anyOf_i0" id="Return_value_ports_anyOf_i0" onclick="setAnchor('#Return_value_ports_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_ports_anyOf_i1" id="Return_value_ports_anyOf_i1" onclick="setAnchor('#Return_value_ports_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_ports_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: array of integer</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="Return_value_ports_anyOf_i0_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_ports_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_NVME_TARGET_WRITE

