.. _interface_brief_oper:

interface brief oper
====================

Operational Status for the object brief


brief Specification
-------------------

	===================================== =============================================================
	 **Parameter**                         **Value** 

	===================================== =============================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      brief

	 **Element URI**                       /axapi/v3/interface/brief/oper

	 **Element Attributes**                brief_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`brief schema <interface-brief-oper/interface-brief-oper.txt>`
	===================================== =============================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/interface/brief/oper



.. raw:: html

   </td><td valign = 'top'>


:ref:`1899_brief_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/interface/brief/oper



.. raw:: html

   </td><td valign = 'top'>


:ref:`1899_brief_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/interface/brief/oper



.. raw:: html

   </td><td valign = 'top'>


:ref:`1899_brief_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/interface/brief/oper



.. raw:: html

   </td><td valign = 'top'>


:ref:`1899_brief_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/interface/brief/oper



.. raw:: html

   </td><td valign = 'top'>


:ref:`1899_brief_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1899_brief_attributes:

brief attributes
----------------

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`1899_oper` 

        **Type:** Object

.. _1899_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **interfaces**

        **Type:** List

.. _1899_oper_interfaces:

oper_interfaces
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **duplexity**

        **Description** 

        **Type:** string

    **encap_info**

        **Description** 

        **Type:** string

    **intf_name**

        **Description** 

        **Type:** string

    **ipv4_addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv4_addr_count**

        **Description** 

        **Type:** number

    **ipv4_mask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

    **ipv6_addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv6-address

    **ipv6_addr_count**

        **Description** 

        **Type:** number

    **ipv6_prefix**

        **Description** IP subnet mask

        **Type:** string

    **mac**

        **Description** 

        **Type:** string

        **Format:** mac-address

        **Maximum Length:** 17 characters

        **Maximum Length:** 11 characters

    **port_num**

        **Description** 

        **Type:** string

    **speed**

        **Description** 

        **Type:** string

    **state**

        **Description** 

        **Type:** string

    **trunk_group**

        **Description** 

        **Type:** string

    **unnumbered_oper**

        **Description** 

        **Type:** string

    **vlan_info**

        **Description** 

        **Type:** string