<commit_before>Connections
===========

Connecting to BIG-IP with the SDK is done via :class:`f5.bigip.ManagementRoot`.

.. code-block:: python

    >>> from f5.bigip import ManagementRoot
    >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass')

The required parameters are host, username, and password, respectively.

You can, however, supply one or more of the following kwargs (defaults listed):

.. table::

    ================ =====
    timeout          30
    port             443
    icontrol_version ''
    token            False
    token_to_use     None
    verify           False
    auth_provider    None
    ================ =====

.. topic:: Example: Use token authentication on the nonstandard 4443 tcp port

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1.', 'user', 'pass', port=4443, token=True)

.. topic:: Example: Use existing authentication token

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass', token=True, token_to_use='<KEY>'

.. topic:: Example: Enable cert verification

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass', verify=True)
<commit_msg>Shorten example token for readability's sake and add missing ) in example<commit_after>Connections
===========

Connecting to BIG-IP with the SDK is done via :class:`f5.bigip.ManagementRoot`.

.. code-block:: python

    >>> from f5.bigip import ManagementRoot
    >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass')

The required parameters are host, username, and password, respectively.

You can, however, supply one or more of the following kwargs (defaults listed):

.. table::

    ================ =====
    timeout          30
    port             443
    icontrol_version ''
    token            False
    token_to_use     None
    verify           False
    auth_provider    None
    ================ =====

.. topic:: Example: Use token authentication on the nonstandard 4443 tcp port

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1.', 'user', 'pass', port=4443, token=True)

.. topic:: Example: Use existing authentication token

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass', token=True, token_to_use='<PASSWORD>')

.. topic:: Example: Enable cert verification

    .. code-block:: python

        >>> from f5.bigip import ManagementRoot
        >>> mgmt = ManagementRoot('192.168.1.1', 'user', 'pass', verify=True)

{'fraction_non_alphanumeric': 0.15572574762946753, 'fraction_numerical': 0.03646973012399708, 'mean_word_length': 2.8417366946778713, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 53, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 8, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5083940', 'n_tokens_mistral': 834, 'n_tokens_neox': 754, 'n_words': 238}