ipmi.lan.update
===============

Update IPMI channel configuration

.. 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: channel</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>channel</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>IPMI LAN channel number to update.</p> </span> </div> </div> <h5>Parameter 2: data</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>data</h4><br/> <span class="description"><p>IPMI LAN configuration data (DHCP or static IP).</p> </span><div class="one-of-value" id="Call_parameters_items_i1_oneOf"><h2 class="handle"> <label>One of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oneOf_oneOf" role="tablist"><li class="nav-item"> <a class="nav-link active oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i0" id="Call_parameters_items_i1_oneOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0')" role="tab">IPMILanUpdateOptionsDHCP</a> </li><li class="nav-item"> <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i1" id="Call_parameters_items_i1_oneOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1')" role="tab">IPMILanUpdateOptionsStatic</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_oneOf_i0" role="tabpanel"> <h4>IPMILanUpdateOptionsDHCP</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_i1_oneOf_i0_dhcp"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i0_dhcp"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i0_dhcp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i0_dhcp" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_dhcp')" type="button"><span class="property-name">dhcp</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i0_dhcp" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i0_dhcp" id="Call_parameters_items_i1_oneOf_i0_dhcp"> <div class="card-body pl-5"> <h4>Dhcp</h4><span class="badge badge-dark value-type">Type: const</span><br/> <span class="description"><p>Turn on DHCP protocol for IP address management.</p> </span><div class="enum-value" id="Call_parameters_items_i1_oneOf_i0_dhcp_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">true</li></ul> </div><span class="const-value" id="Call_parameters_items_i1_oneOf_i0_dhcp_const">Specific value: <code>true</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oneOf_i0_password"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i0_password"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i0_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i0_password" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_password')" type="button"><span class="property-name">password</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i0_password" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i0_password" id="Call_parameters_items_i1_oneOf_i0_password"> <div class="card-body pl-5"> <h4>Password</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>The password to be applied. Must be between 8 and 16 characters long and contain only ascii upper,lower, 0-9, and special characters.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_oneOf_i0_password_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oneOf_i0_password_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i0_password_anyOf_i0" id="Call_parameters_items_i1_oneOf_i0_password_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_password_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_i1_oneOf_i0_password_anyOf_i1" id="Call_parameters_items_i1_oneOf_i0_password_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_password_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_i1_oneOf_i0_password_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_i1_oneOf_i0_password_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_i1_oneOf_i0_vlan"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i0_vlan"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i0_vlan" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i0_vlan" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_vlan')" type="button"><span class="property-name">vlan</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i0_vlan" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i0_vlan" id="Call_parameters_items_i1_oneOf_i0_vlan"> <div class="card-body pl-5"> <h4>Vlan</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>The vlan tag number. A null value disables tagging.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_oneOf_i0_vlan_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oneOf_i0_vlan_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i0_vlan_anyOf_i0" id="Call_parameters_items_i1_oneOf_i0_vlan_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_vlan_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_i1_oneOf_i0_vlan_anyOf_i1" id="Call_parameters_items_i1_oneOf_i0_vlan_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_vlan_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_i1_oneOf_i0_vlan_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_i1_oneOf_i0_vlan_anyOf_i0_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>4096</code></span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_oneOf_i0_vlan_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_i1_oneOf_i0_apply_remote"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i0_apply_remote"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i0_apply_remote" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i0_apply_remote" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i0_apply_remote')" type="button"><span class="property-name">apply_remote</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i0_apply_remote" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i0_apply_remote" id="Call_parameters_items_i1_oneOf_i0_apply_remote"> <div class="card-body pl-5"> <h4>Apply Remote</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>If on an HA system, and this field is set to True, the settings will be sent to the remote controller.</p> </span> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_oneOf_i1" role="tabpanel"> <h4>IPMILanUpdateOptionsStatic</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_i1_oneOf_i1_dhcp"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_dhcp"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_dhcp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_dhcp" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_dhcp')" type="button"><span class="property-name">dhcp</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_dhcp" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_dhcp" id="Call_parameters_items_i1_oneOf_i1_dhcp"> <div class="card-body pl-5"> <h4>Dhcp</h4><span class="badge badge-dark value-type">Type: const</span><br/> <span class="description"><p>Provide a static IP address.</p> </span><div class="enum-value" id="Call_parameters_items_i1_oneOf_i1_dhcp_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">false</li></ul> </div><span class="const-value" id="Call_parameters_items_i1_oneOf_i1_dhcp_const">Specific value: <code>false</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oneOf_i1_password"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_password"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_password" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_password" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_password')" type="button"><span class="property-name">password</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_password" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_password" id="Call_parameters_items_i1_oneOf_i1_password"> <div class="card-body pl-5"> <h4>Password</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>The password to be applied. Must be between 8 and 16 characters long and contain only ascii upper,lower, 0-9, and special characters.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_oneOf_i1_password_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oneOf_i1_password_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i1_password_anyOf_i0" id="Call_parameters_items_i1_oneOf_i1_password_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_password_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_i1_oneOf_i1_password_anyOf_i1" id="Call_parameters_items_i1_oneOf_i1_password_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_password_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_i1_oneOf_i1_password_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_i1_oneOf_i1_password_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_i1_oneOf_i1_vlan"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_vlan"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_vlan" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_vlan" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_vlan')" type="button"><span class="property-name">vlan</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_vlan" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_vlan" id="Call_parameters_items_i1_oneOf_i1_vlan"> <div class="card-body pl-5"> <h4>Vlan</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>The vlan tag number. A null value disables tagging.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_oneOf_i1_vlan_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_oneOf_i1_vlan_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_oneOf_i1_vlan_anyOf_i0" id="Call_parameters_items_i1_oneOf_i1_vlan_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_vlan_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_i1_oneOf_i1_vlan_anyOf_i1" id="Call_parameters_items_i1_oneOf_i1_vlan_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_vlan_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_i1_oneOf_i1_vlan_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_i1_oneOf_i1_vlan_anyOf_i0_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>4096</code></span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_oneOf_i1_vlan_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_i1_oneOf_i1_apply_remote"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_apply_remote"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_apply_remote" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_apply_remote" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_apply_remote')" type="button"><span class="property-name">apply_remote</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_apply_remote" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_apply_remote" id="Call_parameters_items_i1_oneOf_i1_apply_remote"> <div class="card-body pl-5"> <h4>Apply Remote</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>If on an HA system, and this field is set to True, the settings will be sent to the remote controller.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oneOf_i1_ipaddress"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_ipaddress"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_ipaddress" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_ipaddress" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_ipaddress')" type="button"><span class="property-name">ipaddress</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_ipaddress" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_ipaddress" id="Call_parameters_items_i1_oneOf_i1_ipaddress"> <div class="card-body pl-5"> <h4>Ipaddress</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The IPv4 address in the form of <code>192.168.1.150</code>.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oneOf_i1_netmask"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_netmask"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_netmask" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_netmask" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_netmask')" type="button"><span class="property-name">netmask</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_netmask" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_netmask" id="Call_parameters_items_i1_oneOf_i1_netmask"> <div class="card-body pl-5"> <h4>Netmask</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The netmask in the form of <code>255.255.255.0</code>.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_oneOf_i1_gateway"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_oneOf_i1_gateway"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_oneOf_i1_gateway" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_oneOf_i1_gateway" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_oneOf_i1_gateway')" type="button"><span class="property-name">gateway</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_oneOf_i1_gateway" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_oneOf_i1_gateway" id="Call_parameters_items_i1_oneOf_i1_gateway"> <div class="card-body pl-5"> <h4>Gateway</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The gateway in the form of <code>192.168.1.1</code>.</p> </span> </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>Result</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Returns the channel number that was updated.</p> </span> </div> </div> </div> </div> </div><br><br>

*Required roles:* IPMI_WRITE

