.. _interface_ethernet_oper:

interface ethernet oper
=======================

Operational Status for the object ethernet


ethernet Specification
----------------------

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

	===================================== ========================================================================
	 **Type**                              *Collection*

	 **Collection Name**                   :ref:`1929_ethernet_list`

	 **Collection URI**                    /axapi/v3/interface/ethernet/{ifnum}

	                                       

	 **Element Name**                      ethernet

	 **Element URI**                       /axapi/v3/interface/ethernet/{ifnum}/oper

	 **Element Attributes**                ethernet_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`ethernet schema <interface-ethernet-oper/interface-ethernet-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/ethernet/{ifnum}



.. raw:: html

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


:ref:`1929_ethernet_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}



.. raw:: html

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


:ref:`1929_ethernet_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/ethernet/{ifnum}/oper



.. raw:: html

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


:ref:`1929_ethernet_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}



.. raw:: html

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


:ref:`1929_ethernet_list`



.. 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/ethernet/{ifnum}/oper



.. raw:: html

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


:ref:`1929_ethernet_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/ethernet/{ifnum}/oper



.. raw:: html

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


:ref:`1929_ethernet_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/interface/ethernet/{ifnum}



.. raw:: html

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


:ref:`1929_ethernet_list`



.. 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/ethernet/{ifnum}/oper



.. raw:: html

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


:ref:`1929_ethernet_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1929_ethernet_list:

ethernet-list
-------------


    ethernet-list is **JSON List** of :ref:`1929_ethernet_attributes` 

        ethernet-list : [

             { :ref:`1929_ethernet_attributes` },

             { :ref:`1929_ethernet_attributes` },

             ...

         ]

.. _1929_ethernet_attributes:

ethernet attributes
-------------------

    **ifnum**

        **Description** Ethernet interface number

        **Type:** number

        **Format:** interface

    **oper**

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

        **Type:** Object

.. _1929_oper:

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

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

    **actual_duplexity**

        **Description** 

        **Type:** string

        **Supported Values:** Full, fdx, Half, hdx, auto

    **actual_speed**

        **Description** 

        **Type:** string

        **Supported Values:** 10Mbit, 100Mbit, 1Gbit, 10Gbit, 40Gbit, unknown

    **config_duplexity**

        **Description** 

        **Type:** string

        **Supported Values:** Full, fdx, Half, hdx, auto

    **config_speed**

        **Description** 

        **Type:** string

        **Supported Values:** 10Mbit, 100Mbit, 1Gbit, 10Gbit, 40Gbit, auto

    **current_vnp_id**

        **Description** 

        **Type:** number

    **icmp-rate-limit-current**

        **Description** 

        **Type:** number

    **icmp-rate-over-limit-drop**

        **Description** 

        **Type:** number

    **icmp6-rate-limit-current**

        **Description** 

        **Type:** number

    **icmp6-rate-over-limit-drop**

        **Description** 

        **Type:** number

    **igmp-query-sent**

        **Description** 

        **Type:** number

    **incoming_pkts_mirrored**

        **Description** 

        **Type:** number

    **incoming_pkts_monitored**

        **Description** 

        **Type:** number

    **input_utilization**

        **Description** 

        **Type:** number

    **ip_unnumbered_enabled**

        **Description** 

        **Type:** number

    **ip_unnumbered_mac_learned**

        **Description** 

        **Type:** number

    **ip_unnumbered_oper**

        **Description** 

        **Type:** number

    **ip_unnumbered_peer_lla**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **ipv4-address**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **ipv4-netmask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

    **ipv4_addr_count**

        **Description** 

        **Type:** number

    **ipv4_list**

        **Type:** List

    **ipv6-link-local**

        **Description** 

        **Type:** string

        **Format:** ipv6-address

    **ipv6-link-local-prefix**

        **Description** 

        **Type:** string

    **ipv6-link-local-scope**

        **Description** 

        **Type:** string

    **ipv6-link-local-type**

        **Description** 

        **Type:** string

    **ipv6_addr_count**

        **Description** 

        **Type:** number

    **ipv6_list**

        **Type:** List

    **is-tagged**

        **Description** 

        **Type:** number

    **is_blocked**

        **Description** 

        **Type:** number

    **is_device_transparent**

        **Description** 

        **Type:** number

    **is_lead_member**

        **Description** 

        **Type:** number

    **is_pristine**

        **Description** 

        **Type:** number

    **last_count_clear_at**

        **Description** 

        **Type:** string

    **last_down_event_at**

        **Description** 

        **Type:** string

    **last_up_event_at**

        **Description** 

        **Type:** string

    **line_protocol**

        **Description** 

        **Type:** string

        **Supported Values:** up, down

    **link_type**

        **Description** 

        **Type:** string

        **Supported Values:** GigabitEthernet, 10Gig, 40Gig

    **mac**

        **Description** 

        **Type:** string

        **Format:** mac-address

        **Maximum Length:** 17 characters

        **Maximum Length:** 11 characters

    **media_type**

        **Description** 

        **Type:** string

        **Supported Values:** Copper, Fiber

    **outgoing_pkts_mirrored**

        **Description** 

        **Type:** number

    **outgoing_pkts_monitored**

        **Description** 

        **Type:** number

    **output_utilization**

        **Description** 

        **Type:** number

    **port_vnp_id**

        **Description** 

        **Type:** number

    **rate_byte_rcvd**

        **Description** 

        **Type:** number

    **rate_byte_sent**

        **Description** 

        **Type:** number

    **rate_pkt_rcvd**

        **Description** 

        **Type:** number

    **rate_pkt_sent**

        **Description** 

        **Type:** number

    **span_mode**

        **Description** 

        **Type:** string

    **span_port_state**

        **Description** 

        **Type:** string

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** up, disabled, down

    **tagged-vlan-list**

        **Description** 

        **Type:** string

    **vlan-id**

        **Description** 

        **Type:** number

.. _1929_oper_ipv4_list:

oper_ipv4_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv4-address

    **mask**

        **Description** IP subnet mask

        **Type:** string

        **Format:** ipv4-netmask

.. _1929_oper_ipv6_list:

oper_ipv6_list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** IP address

        **Type:** string

        **Format:** ipv6-address

    **is_anycast**

        **Description** 

        **Type:** number

    **prefix**

        **Description** IP subnet mask

        **Type:** string