# MIT LICENSE
#
# Copyright 1997 - 2020 by IXIA Keysight
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE. 
import sys
from ixnetwork_restpy.base import Base
from ixnetwork_restpy.files import Files
if sys.version_info >= (3, 5):
    from typing import List, Any, Union


class TunnelLeafRange(Base):
    """The tunnelLeafRange object is enabled only if the emulation type in Tunnel Tail Ranges is set to RSVP-TE P2MP. There is separate configuration for Ingress and Egress leaf nodes.
    The TunnelLeafRange class encapsulates a list of tunnelLeafRange resources that are managed by the user.
    A list of resources can be retrieved from the server using the TunnelLeafRange.find() method.
    The list can be managed by using the TunnelLeafRange.add() and TunnelLeafRange.remove() methods.
    """

    __slots__ = ()
    _SDM_NAME = 'tunnelLeafRange'
    _SDM_ATT_MAP = {
        'Enabled': 'enabled',
        'IpCount': 'ipCount',
        'IpStart': 'ipStart',
        'SubLspDown': 'subLspDown',
    }
    _SDM_ENUM_MAP = {
    }

    def __init__(self, parent, list_op=False):
        super(TunnelLeafRange, self).__init__(parent, list_op)

    @property
    def Enabled(self):
        # type: () -> bool
        """
        Returns
        -------
        - bool: If true, enables the RSVP-TE Tunnel Tail Range.
        """
        return self._get_attribute(self._SDM_ATT_MAP['Enabled'])
    @Enabled.setter
    def Enabled(self, value):
        # type: (bool) -> None
        self._set_attribute(self._SDM_ATT_MAP['Enabled'], value)

    @property
    def IpCount(self):
        # type: () -> int
        """
        Returns
        -------
        - number: The number of IPv4 addresses in the range of Tunnel Tail addresses.
        """
        return self._get_attribute(self._SDM_ATT_MAP['IpCount'])
    @IpCount.setter
    def IpCount(self, value):
        # type: (int) -> None
        self._set_attribute(self._SDM_ATT_MAP['IpCount'], value)

    @property
    def IpStart(self):
        # type: () -> str
        """
        Returns
        -------
        - str: The first IPv4 address in the range of Tunnel Tail addresses to be associated with the Ixia-emulated RSVP-TE router.
        """
        return self._get_attribute(self._SDM_ATT_MAP['IpStart'])
    @IpStart.setter
    def IpStart(self, value):
        # type: (str) -> None
        self._set_attribute(self._SDM_ATT_MAP['IpStart'], value)

    @property
    def SubLspDown(self):
        # type: () -> bool
        """
        Returns
        -------
        - bool: This can be true only for Tail Ranges of type 'Egress'. If enabled and a sub-lsp to the tail is up, it is torn-down by sending a Resv Tear to the ingress. From this point onwards, any Path sent to this Tail is dropped silently, thereby simulating that the sub-lsps terminating on the endpoints in this Tail Range is down.
        """
        return self._get_attribute(self._SDM_ATT_MAP['SubLspDown'])
    @SubLspDown.setter
    def SubLspDown(self, value):
        # type: (bool) -> None
        self._set_attribute(self._SDM_ATT_MAP['SubLspDown'], value)

    def update(self, Enabled=None, IpCount=None, IpStart=None, SubLspDown=None):
        # type: (bool, int, str, bool) -> TunnelLeafRange
        """Updates tunnelLeafRange resource on the server.

        Args
        ----
        - Enabled (bool): If true, enables the RSVP-TE Tunnel Tail Range.
        - IpCount (number): The number of IPv4 addresses in the range of Tunnel Tail addresses.
        - IpStart (str): The first IPv4 address in the range of Tunnel Tail addresses to be associated with the Ixia-emulated RSVP-TE router.
        - SubLspDown (bool): This can be true only for Tail Ranges of type 'Egress'. If enabled and a sub-lsp to the tail is up, it is torn-down by sending a Resv Tear to the ingress. From this point onwards, any Path sent to this Tail is dropped silently, thereby simulating that the sub-lsps terminating on the endpoints in this Tail Range is down.

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._update(self._map_locals(self._SDM_ATT_MAP, locals()))

    def add(self, Enabled=None, IpCount=None, IpStart=None, SubLspDown=None):
        # type: (bool, int, str, bool) -> TunnelLeafRange
        """Adds a new tunnelLeafRange resource on the server and adds it to the container.

        Args
        ----
        - Enabled (bool): If true, enables the RSVP-TE Tunnel Tail Range.
        - IpCount (number): The number of IPv4 addresses in the range of Tunnel Tail addresses.
        - IpStart (str): The first IPv4 address in the range of Tunnel Tail addresses to be associated with the Ixia-emulated RSVP-TE router.
        - SubLspDown (bool): This can be true only for Tail Ranges of type 'Egress'. If enabled and a sub-lsp to the tail is up, it is torn-down by sending a Resv Tear to the ingress. From this point onwards, any Path sent to this Tail is dropped silently, thereby simulating that the sub-lsps terminating on the endpoints in this Tail Range is down.

        Returns
        -------
        - self: This instance with all currently retrieved tunnelLeafRange resources using find and the newly added tunnelLeafRange resources available through an iterator or index

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._create(self._map_locals(self._SDM_ATT_MAP, locals()))

    def remove(self):
        """Deletes all the contained tunnelLeafRange resources in this instance from the server.

        Raises
        ------
        - NotFoundError: The requested resource does not exist on the server
        - ServerError: The server has encountered an uncategorized error condition
        """
        self._delete()

    def find(self, Enabled=None, IpCount=None, IpStart=None, SubLspDown=None):
        # type: (bool, int, str, bool) -> TunnelLeafRange
        """Finds and retrieves tunnelLeafRange resources from the server.

        All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve tunnelLeafRange resources from the server.
        To retrieve an exact match ensure the parameter value starts with ^ and ends with $
        By default the find method takes no parameters and will retrieve all tunnelLeafRange resources from the server.

        Args
        ----
        - Enabled (bool): If true, enables the RSVP-TE Tunnel Tail Range.
        - IpCount (number): The number of IPv4 addresses in the range of Tunnel Tail addresses.
        - IpStart (str): The first IPv4 address in the range of Tunnel Tail addresses to be associated with the Ixia-emulated RSVP-TE router.
        - SubLspDown (bool): This can be true only for Tail Ranges of type 'Egress'. If enabled and a sub-lsp to the tail is up, it is torn-down by sending a Resv Tear to the ingress. From this point onwards, any Path sent to this Tail is dropped silently, thereby simulating that the sub-lsps terminating on the endpoints in this Tail Range is down.

        Returns
        -------
        - self: This instance with matching tunnelLeafRange resources retrieved from the server available through an iterator or index

        Raises
        ------
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._select(self._map_locals(self._SDM_ATT_MAP, locals()))

    def read(self, href):
        """Retrieves a single instance of tunnelLeafRange data from the server.

        Args
        ----
        - href (str): An href to the instance to be retrieved

        Returns
        -------
        - self: This instance with the tunnelLeafRange resources from the server available through an iterator or index

        Raises
        ------
        - NotFoundError: The requested resource does not exist on the server
        - ServerError: The server has encountered an uncategorized error condition
        """
        return self._read(href)
