.. _slb_player_id_global:

slb player-id-global
====================

Player-id global commands


player-id-global Specification
------------------------------

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

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

	 **Element Name**                      player-id-global

	 **Element URI**                       /axapi/v3/slb/player-id-global

	 **Element Attributes**                player-id-global_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/slb/player-id-global/stats

	 **Operational Data URI**              /axapi/v3/slb/player-id-global/oper

	 **Schema**                             :download:`player-id-global schema <slb-player-id-global/slb-player-id-global.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/slb/player-id-global



.. raw:: html

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


:ref:`2844_player-id-global_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/slb_player_id_global_POST.txt
   :literal:




.. raw:: html

   </div></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/slb/player-id-global



.. raw:: html

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


:ref:`2844_player-id-global_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/slb_player_id_global_GET.txt
   :literal:




.. raw:: html

   </div></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/slb/player-id-global



.. raw:: html

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


:ref:`2844_player-id-global_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/slb/player-id-global



.. raw:: html

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


:ref:`2844_player-id-global_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/slb_player_id_global_PUT.txt
   :literal:




.. raw:: html

   </div></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/slb/player-id-global



.. raw:: html

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


:ref:`2844_player-id-global_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/slb_player_id_global_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2844_player-id-global_attributes:

player-id-global attributes
---------------------------

    **abs-max-expiration**

        **Description** Absolute max record expiration value (default 10 minutes) (Absolute max record expiration time in minutes, default 10)

        **Type:** number

        **Range:** 1-32767

        **Default:** 10

    **enable-64bit-player-id**

        **Description** Enable 64 bit player id check. Default is 32 bit

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **enforcement-timer**

        **Description** Time to playerid enforcement after bootup (default 480 seconds) (Time to playerid enforcement in seconds, default 480)

        **Type:** number

        **Range:** 1-32767

        **Default:** 480

    **force-passive**

        **Description** Forces the device to be in passive mode (Only stats and no packet drops)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **min-expiration**

        **Description** Minimum record expiration value (default 1 min) (Min record expiration time in minutes, default 1)

        **Type:** number

        **Range:** 1-32767

        **Default:** 1

    **pkt-activity-expiration**

        **Description** Packet activity record expiration value (default 5 minutes) (Packet activity record expiration time in minutes, default 5)

        **Type:** number

        **Range:** 1-32767

        **Default:** 5

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2844_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total_playerids_created': Playerid records created; 'total_playerids_deleted': Playerid records deleted; 'total_abs_max_age_outs': Playerid records max time aged out; 'total_pkt_activity_age_outs': Playerid records idle timeout; 'total_invalid_playerid_pkts': Invalid playerid packets; 'total_invalid_playerid_drops': Invalid playerid packet drops; 'total_valid_playerid_pkts': Valid playerid packets; 

        **Type:** string

        **Supported Values:** all, total_playerids_created, total_playerids_deleted, total_abs_max_age_outs, total_pkt_activity_age_outs, total_invalid_playerid_pkts, total_invalid_playerid_drops, total_valid_playerid_pkts