jbof.create
===========

Create a new JBOF.

This will use the supplied Redfish credentials to configure the data plane on the expansion shelf for direct connection to ROCE capable network cards on the TrueNAS head unit.

.. 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: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>JBOF configuration data for creation.</p>
    </span> <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><br/>
    <span class="description"><p>Optional description of the JBOF.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mgmt_ip1">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mgmt_ip1">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mgmt_ip1" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mgmt_ip1" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip1')" type="button"><span class="property-name">mgmt_ip1</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mgmt_ip1" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mgmt_ip1" id="Call_parameters_items_i0_mgmt_ip1">
    <div class="card-body pl-5">
    <h4>Mgmt Ip1</h4><br/>
    <span class="description"><p>IP of first Redfish management interface.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_mgmt_ip1_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_mgmt_ip1_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_mgmt_ip1_anyOf_i0" id="Call_parameters_items_i0_mgmt_ip1_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip1_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_mgmt_ip1_anyOf_i1" id="Call_parameters_items_i0_mgmt_ip1_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip1_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_mgmt_ip1_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i0_mgmt_ip1_anyOf_i0_const">Specific value: <code>""</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_mgmt_ip1_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mgmt_ip2">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mgmt_ip2">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mgmt_ip2" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mgmt_ip2" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip2')" type="button"><span class="property-name">mgmt_ip2</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mgmt_ip2" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mgmt_ip2" id="Call_parameters_items_i0_mgmt_ip2">
    <div class="card-body pl-5">
    <h4>Mgmt Ip2</h4><br/>
    <span class="description"><p>Optional IP of second Redfish management interface.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_mgmt_ip2_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_mgmt_ip2_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_mgmt_ip2_anyOf_i0" id="Call_parameters_items_i0_mgmt_ip2_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip2_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_mgmt_ip2_anyOf_i1" id="Call_parameters_items_i0_mgmt_ip2_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_mgmt_ip2_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_mgmt_ip2_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i0_mgmt_ip2_anyOf_i0_const">Specific value: <code>""</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_mgmt_ip2_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mgmt_username">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mgmt_username">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mgmt_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mgmt_username" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mgmt_username')" type="button"><span class="property-name">mgmt_username</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mgmt_username" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mgmt_username" id="Call_parameters_items_i0_mgmt_username">
    <div class="card-body pl-5">
    <h4>Mgmt Username</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Redfish administrative username.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mgmt_password">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mgmt_password">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mgmt_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mgmt_password" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mgmt_password')" type="button"><span class="property-name">mgmt_password</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mgmt_password" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mgmt_password" id="Call_parameters_items_i0_mgmt_password">
    <div class="card-body pl-5">
    <h4>Mgmt Password</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Redfish administrative password.</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>JBOFEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The created JBOF 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 JBOF configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_description">
    <div class="card">
    <div class="card-header" id="headingReturn_value_description">
    <h2 class="mb-0">
    <button aria-controls="Return_value_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_description" data-toggle="collapse" onclick="setAnchor('#Return_value_description')" type="button"><span class="property-name">description</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_description" class="collapse property-definition-div" data-parent="#accordionReturn_value_description" id="Return_value_description">
    <div class="card-body pl-5">
    <h4>Description</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Optional description of the JBOF.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mgmt_ip1">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mgmt_ip1">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mgmt_ip1" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mgmt_ip1" data-toggle="collapse" onclick="setAnchor('#Return_value_mgmt_ip1')" type="button"><span class="property-name">mgmt_ip1</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mgmt_ip1" class="collapse property-definition-div" data-parent="#accordionReturn_value_mgmt_ip1" id="Return_value_mgmt_ip1">
    <div class="card-body pl-5">
    <h4>Mgmt Ip1</h4><br/>
    <span class="description"><p>IP of first Redfish management interface.</p>
    </span><div class="any-of-value" id="Return_value_mgmt_ip1_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_mgmt_ip1_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_mgmt_ip1_anyOf_i0" id="Return_value_mgmt_ip1_anyOf_i0" onclick="setAnchor('#Return_value_mgmt_ip1_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_mgmt_ip1_anyOf_i1" id="Return_value_mgmt_ip1_anyOf_i1" onclick="setAnchor('#Return_value_mgmt_ip1_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_mgmt_ip1_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_mgmt_ip1_anyOf_i0_const">Specific value: <code>""</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_mgmt_ip1_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mgmt_ip2">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mgmt_ip2">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mgmt_ip2" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mgmt_ip2" data-toggle="collapse" onclick="setAnchor('#Return_value_mgmt_ip2')" type="button"><span class="property-name">mgmt_ip2</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mgmt_ip2" class="collapse property-definition-div" data-parent="#accordionReturn_value_mgmt_ip2" id="Return_value_mgmt_ip2">
    <div class="card-body pl-5">
    <h4>Mgmt Ip2</h4><br/>
    <span class="description"><p>Optional IP of second Redfish management interface.</p>
    </span><div class="any-of-value" id="Return_value_mgmt_ip2_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_mgmt_ip2_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_mgmt_ip2_anyOf_i0" id="Return_value_mgmt_ip2_anyOf_i0" onclick="setAnchor('#Return_value_mgmt_ip2_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_mgmt_ip2_anyOf_i1" id="Return_value_mgmt_ip2_anyOf_i1" onclick="setAnchor('#Return_value_mgmt_ip2_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_mgmt_ip2_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_mgmt_ip2_anyOf_i0_const">Specific value: <code>""</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_mgmt_ip2_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mgmt_username">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mgmt_username">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mgmt_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mgmt_username" data-toggle="collapse" onclick="setAnchor('#Return_value_mgmt_username')" type="button"><span class="property-name">mgmt_username</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mgmt_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_mgmt_username" id="Return_value_mgmt_username">
    <div class="card-body pl-5">
    <h4>Mgmt Username</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Redfish administrative username.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mgmt_password">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mgmt_password">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mgmt_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mgmt_password" data-toggle="collapse" onclick="setAnchor('#Return_value_mgmt_password')" type="button"><span class="property-name">mgmt_password</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mgmt_password" class="collapse property-definition-div" data-parent="#accordionReturn_value_mgmt_password" id="Return_value_mgmt_password">
    <div class="card-body pl-5">
    <h4>Mgmt Password</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Redfish administrative password.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_index">
    <div class="card">
    <div class="card-header" id="headingReturn_value_index">
    <h2 class="mb-0">
    <button aria-controls="Return_value_index" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_index" data-toggle="collapse" onclick="setAnchor('#Return_value_index')" type="button"><span class="property-name">index</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_index" class="collapse property-definition-div" data-parent="#accordionReturn_value_index" id="Return_value_index">
    <div class="card-body pl-5">
    <h4>Index</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Index of the JBOF.  Used to determine data plane IP addresses.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_uuid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_uuid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_uuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_uuid" data-toggle="collapse" onclick="setAnchor('#Return_value_uuid')" type="button"><span class="property-name">uuid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_uuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_uuid" id="Return_value_uuid">
    <div class="card-body pl-5">
    <h4>Uuid</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>UUID of the JBOF as reported by the enclosure firmware.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* JBOF_WRITE

